• cron - Run cron jobs with ease
• go-api-router - Fast and lightweight router
• go-cache - Redis caching made easy
• go-logger - Local or remote logging
• go-mail - Email using multiple providers
• go-sanitize - Clean data effortlessly
• goose - Database migration
• ozzo-validation - Extensible data validation
• SQLBoiler - Powerful database ORM & model generation
• viper - Go configuration with fangs

goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser.

The .goreleaser.yml file is used to configure goreleaser.

Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.

View all makefile commands

make help

List of all current commands:

all                    Runs multiple commands
clean                  Remove previous builds and any test cache data
clean-mods             Remove all the Go mod cache
coverage               Shows the test coverage
db                     Creates a fresh database
env                    Creates a fresh database
flush-redis            Wipe out all data in redis (requires redli)
godocs                 Sync the latest tag with GoDocs
help                   Show this help message
install                Install the application
install                Run the Custom installation
install-go             Install the application (Using Native Go)
lint                   Run the golangci-lint application (install if not found)
release                Full production release (creates release in Github)
release                Runs common.release then runs godocs
release-snap           Test the full release (build binaries)
release-test           Full production test release (everything except deploy)
replace-version        Replaces the version in HTML/JS (pre-deploy)
run                    Runs the application
run-examples           Runs all the examples
schema                 Run the Model/schema generation
tag                    Generate a new tag and push (tag version=0.0.0)
tag-remove             Remove a tag if found (tag-remove version=0.0.0)
tag-update             Update an existing tag to current commit (tag-update version=0.0.0)
test                   Runs vet, lint and ALL tests
test-short             Runs vet, lint and tests (excludes integration tests)
test-travis            Runs all tests via Travis (also exports coverage)
test-travis-short      Runs unit tests via Travis (also exports coverage)
uninstall              Uninstall the application (and remove files)
update-linter          Update the golangci-lint package (macOS only)
vet                    Run the Go vet application

Update the reset_api_database.sql if you have issues running the model tests

GRANT ALL ON `dynamic-database-name-generated-from-sql-boiler`.* to 'apiDbTestUser'@'%';

Rebuilding the generated models/schema from the database schema:

make schema

Clear local redis and reload the database

make db
make flush-redis

All environment variables are referenced in the config.

Edit the scripts/set_env.sh file and modify the environment variables - IE:

export API_SERVER_PORT=3000