go-startkode

Scaffolding for a go api project.

• Run:
• Prerequisites:
• Setup:
• Usage:

Run:

To simply run the application only docker and docker compose is needed. Firstly rename the .example.env file to .env then run:

docker-compose --profile app up --build

Then the swagger UI can be found on: localhost:8080/api/docs/index.html

Prerequisites:

• Golang
• Make
• docker & docker compose

Setup:

• Run the make install-tools to install necessary development tools. (Ensure your PATH is set up correctly).

• Rename or copy the .example.env file to .env and populate the fields as needed.

• Run docker compose up to start the PostgreSQL Docker container or docker compose up -d to run it in the background.

• Run make migrate-up to setup the database with the tables etc. specified in the db/migration/ folder.

Usage:

The Makefile defines different task to run. When in doubt you can just run make to find out which tasks are available or read the Makefile for more information

$ make
Available targets:
install-tools        # Install dev tools
run                  # Run with live reload
build                # Build application
docs                 # Generate swagger documentation
sqlc                 # Generate slqc boilerplate
migrate-new          # Create new sql migration
migrate-up           # Migrate the db
migrate-down         # Roll back the db
test                 # Run tests
test-verbose         # Run tests with verbose flag
test-cover           # Show test coverage
test-cover-html      # Show test coverage in the browser
test-mutation        # Run mutation testing with gremlins