Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mathcale/go-api-boilerplate
A slightly opinionated HTTP API boilerplate with the Go programming language
https://github.com/mathcale/go-api-boilerplate
api boilerplate clean-architecture golang
Last synced: about 5 hours ago
JSON representation
A slightly opinionated HTTP API boilerplate with the Go programming language
- Host: GitHub
- URL: https://github.com/mathcale/go-api-boilerplate
- Owner: mathcale
- Created: 2024-08-19T04:43:10.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-31T19:51:51.000Z (5 months ago)
- Last Synced: 2025-02-06T20:45:50.371Z (1 day ago)
- Topics: api, boilerplate, clean-architecture, golang
- Language: Go
- Homepage:
- Size: 39.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Go API Boilerplate
A slightly opinionated HTTP API boilerplate with the Go programming language, following (some) Clean Architecture principles.
[](https://github.com/mathcale/go-api-boilerplate/actions/workflows/ci.yaml)
[](https://goreportcard.com/report/github.com/mathcale/go-api-boilerplate)
## Features
- HTTP server with [net/http](https://pkg.go.dev/net/http#hdr-Servers);
- Testing suites, assertions and mocks with [testify](https://github.com/stretchr/testify);
- Live reload with [air](https://github.com/air-verse/air);
- Logging with [zerolog](https://github.com/rs/zerolog);
- Configuration with [viper](https://github.com/spf13/viper);
- Pre-configured CI job with Github Actions;
## Requirements
- [Go](https://go.dev/) 1.23 (or newer)
- [GNU Make](https://www.gnu.org/software/make/)
- [Docker](https://www.docker.com/)
## Running locally
```sh
# Start database
docker compose up -d
# Install dependencies
make setup
# Run the application
make run
```
## Testing
To execute all test suites, just run:
```sh
make tests
```
## Building for production
### With Docker
There's a `Dockerfile.prod` included with the project to build an optimized image based on [distroless](https://github.com/GoogleContainerTools/distroless), so you just need to adapt it for your needs and publish to your desired registry.
```sh
# This should be set by your CI/CD system
export BUILD_ID="$(uuidgen)"
# Building the image
docker build . \
-t mathcale/go-api-boilerplate \
-f Dockerfile.prod \
--build-arg BUILD_ID
# Clean intermediate images
docker image prune \
--filter label=stage=builder \
--filter label=build=$BUILD_ID
```
### Manually
```sh
make build
```
## Next Steps
- [X] Add database connection
- [X] Add logging middleware
- [X] Add Github Actions CI workflow
- [ ] Add database usage example