go-starter-kit

Go Starter Kit for Betterworks Server Applications

Documentation

Clone the repository

$ git clone git@github.com:BetterWorks/go-starter-kit.git
$ cd go-starter-kit

Prerequisites

Show all commands

$ docker compose run --rm api just

Run all up migrations

$ docker compose run --rm api just migrate

Run up migrations {n} steps

$ docker compose run --rm api just migrate-up svcdb {n}

Run down migrations {n} steps

$ docker compose run --rm api just migrate-down svcdb {n}

Create new migration

$ docker compose run --rm api just migrate-create {name}

Run the server in development mode

$ docker compose run --rm --service-ports api

Run the integration test suite with code coverage

$ docker compose run --rm api just coverage

Compile server binary

$ go build -mod vendor -o out/bin/domain ./cmd/httpserver

Create feature branch (git switch -c new-feature)
Commit changes using conventional changelog standards (git commit -m 'feat(scope): adds new feature')
Push to the branch (git push origin new-feature)
Ensure linting and tests are passing
Create new pull request

UNLICENSED