go-api-boilerplate

(★ 229)

Boilerplate for Golang API

File Explorer

- root.go
- seed.go
- server.go
- responses.go
- user_controller.go
- - 20190516163301_Init.go
  - 20250304073807_MigrationName.sql
- - seed_users.go
  - seeds.go
- dbconf.yml
- app.go
- config.go
- migrations.go
- .gitignore
- - dbconf.yml
  - Dockerfile
  - entrypoint.sh
- wait-for-it.sh
- install.sh
- logger.go
- - db.go
- - user.go
- - user_service.go
- - base.go
  - user.go
- api.go
.dockerignore
.env.template
.gitignore
base.env
docker-compose.yml
go.mod
go.sum
main.go
Makefile
README.md

1. Get the code

git clone https://github.com/zubroide/go-api-boilerplate

Downloads the entire project code from GitHub to your computer.

cd go-api-boilerplate

Moves into the project folder you just downloaded.

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker-compose up --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

Medium

Prerequisites

go run main.go server --port=8081

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

Pulled directly from this repo's README.

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make migrate