Starter is a robust project template for Go applications. It provides a solid foundation with essential components like command-line interface, HTTP server, logging, health checks, and version information.
This template follows Go best practices and has a clean, modular structure that makes it easy to extend and maintain.
- Clean architecture with clear separation of concerns
- Command-line interface with environment variable support
- HTTP server with health checks and graceful shutdown
- Structured logging with context propagation
- Task-based build system
- Multi-stage Docker build with minimal final image
- Ready-to-use fly.io deployment configuration
- Go 1.18 or higher
- go-task for running tasks
-
Clone the repository
git clone https://github.com/yourusername/your-project.git cd your-project -
Update the module name
# Edit go.mod to change the module name # Update PACKAGE_PREFIX in Taskfile.yml
-
Install dependencies
go mod tidy
- go-task - A task runner / simpler Make alternative written in Go
- alecthomas/kong - is a command-line parser for Go
- joho/godotenv - loads environment variables from .env file
- go-chi/chi - lightweight, idiomatic and composable router for building Go HTTP services
- gRPC-go - gRPC Health Checking Protocol
- uber-go/zap - Blazing fast, structured, leveled logging in Go
├── cmd - application entry points
├── internal - internal packages
│ ├── app - in here we create application runners
│ │ └── server - server runner
│ └── pkg - internal packages
│ ├── closer - closer package provide a way to close multiple resources
│ ├── logx - logx package provide a way to log messages
│ ├── info - info package provide a information about version and git commit
│ └── healthcheck - healthcheck package provide a healthcheck functionality
├── pkg - public packages
├── .theruziev - project related files (e.g. Docker, taskfile.yml, etc.)
└── .bin - binaries
# Run build
task build
# Run tests
task test
# Run linter
task lint
# Run build
task buildI use fly.io for deployment.
This project includes conventions and guidelines for AI assistants. See CONVENTIONS.md for details.