A modern template for Go projects following clean architecture and design pattern best practices. This template provides a robust and scalable foundation for Go application development.

• ✨ Clean and modular architecture
• 🔒 Clear separation of public and private code
• 📝 Ready-to-use logging and metrics setup
• 🔄 CI/CD configuration
• 🧪 Complete testing structure
• 📚 Automatic Swagger documentation
• 🐳 Docker containerization
• 🛠️ Development-friendly Makefile

.
├── cmd/                    # Application executables
├── internal/              # Private application code
├── pkg/                   # Public libraries
├── configs/              # Configuration files
├── scripts/              # Automation scripts
├── test/                 # Integration tests
└── api/                  # API documentation

• Go 1.21 or higher
• Docker (optional)
• Make (optional)

1. Clone this template:

git clone https://github.com/obrunogonzaga/go-template.git new-project
cd new-project

2. Initialize Go module:

go mod init github.com/your-username/new-project
go mod tidy

3. Run the application:

make run

make build      # Compile the project
make test       # Run tests
make lint       # Run linter
make swagger    # Generate Swagger documentation
make docker     # Build Docker image

• cmd/: Contains application entry points
• internal/: Application-specific code
• pkg/: Libraries that can be used by other projects
• test/: Integration and end-to-end tests

• Use small, focused interfaces
• Follow SOLID principles
• Keep functions short and single-purpose
• Document public APIs

The project uses the following testing tools:

• testing: Standard library for unit tests
• testify: Assertions and mocks
• gomock: Mock generation
• httptest: HTTP endpoint testing

• All dependencies are verified with go mod verify
• Static code analysis with golangci-lint
• Vulnerability scanning with gosec

The project includes configurations for:

• Docker
• Kubernetes (manifests in ./deploy)
• CI/CD (GitHub Actions)

This project is licensed under the MIT License - see the LICENSE file for details.

1. Fork the project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

• Dependency injection
• Interface-based design
• Configuration management
• Error handling
• Middleware support
• Graceful shutdown
• Structured logging
• Metrics and monitoring
• Health checks
• Rate limiting

APP_ENV=development
APP_PORT=8080
DB_HOST=localhost
DB_PORT=5432

The project uses a hierarchical configuration system:

1. Default values
2. Configuration files
3. Environment variables
4. Command line flags

• Custom error types
• Error wrapping
• Structured error responses
• Centralized error handling

• Structured logging with levels
• Request ID tracking
• Performance metrics
• Audit logging

Bruno Gonzaga Santos - @brunogsantos - [email protected]

Project Link: https://github.com/obrunogonzaga/go-template

• Standard Go Project Layout
• Clean Architecture
• Twelve-Factor App