go-api-template

Gin starter repository.

Docs

• Gin

Development

1. Linter
2. Running the app

Linter

First, you need to install golangci-lint.

Please run the following script according to your environment:

Tip

Make sure that ~/go/bin is exist in PATH.

macOS

brew install golangci-lint

Windows & Linux

curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b "$(go env GOPATH)/bin" v1.60.3

Important

For Windows, use Git Bash.

Running the app

Run with Docker to develop with live-reloading (hot-reload).

docker compose up

API route is localhost:8080 as the root.

Modules

1. air
2. godotenv
3. gorm
4. uuid

1. air

Used for live-reloading (hot-reload) development.

2. godotenv

Environment variables library such as dotenv (e.g. .env).

3. gorm

ORM library.

4. uuid

Used to generate UUIDs.