jasonsites / gosk

Go Starter Kit for Modular Backend Applications

gosk

Go Starter Kit for Modular Backend Applications

Documentation

• Architecture
• Getting Started

Installation

Clone the repository

$ git clone [e-mail]:jasonsites/gosk.git
$ cd gosk

Development

Prerequisites

• Docker Desktop
• Go 1.21+

Show all commands

$ docker compose run --rm api just

Migrations

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}

Server

Run http server in development mode

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

Testing

Run unit tests

$ docker compose run --rm api just test-unit

Run integration tests

$ docker compose run --rm api just test-int

Run full test suite with code coverage

$ docker compose run --rm api just coverage

Building

Compile server binary

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

License

Copyright (c) 2022 Jason Sites

Licensed under the MIT License