arthurdotwork / goboiler

Goboiler is my personal golang boilerplate for services & APIs

Goboiler

Goboiler is my personal golang boilerplate for services & APIs. It uses the following packages:

• sqlx and sqalx for database access.
• gin for the http router.
• zerolog for logging.
• tern for database migrations.
• task as a makefile replacement.
• prometheus for metrics.

Getting started

Prerequisites

• Go
• Docker
• Task

Installation

1. Clone the repository

git clone github.com/arthureichelberger/goboiler

2. Install dependencies

task install

3. Start the associated services

docker-compose up -d

4. Run the migrations

task migrate:fresh

5. Run the server

task run

Usage

Run the server

task run

Run the tests

task test # also resets the database

Run the linter

task lint

Run the migrations

task migrate:up # to run the next migrations
task migrate:down # to revert the database
task migrate:fresh # to revert the database and run all the migrations

Create a new migration

task migrate:new -- {{migration_name}} # ex: create_users_table

Build the docker image

task docker:package

Intended usage

This boilerplate is mainly designed for deployment in Kubernetes with a PostgreSQL database. Therefore, certain technical decisions were made, particularly regarding liveness and readiness probes.