bxcodec/go-clean-arch
Go Clean Arch
This project is a boilerplate and template for Go applications implementing Clean Architecture. It provides a standardized project structure designed to organize code into decoupled layers, ensuring that core business logic remains independent of databases, frameworks, and user interfaces.
The implementation focuses on a domain-driven design that utilizes dependency injection and the repository pattern to abstract data storage. It enforces architectural boundaries through internal package encapsulation and layer-based dependency inversion.
The project includes a development toolchain that automates the software lifecycle. This covers a variety of capabilities, including static analysis integration, parallelized test execution with mock dependency generation, and live application reloading.
Deployment and environment management are handled through containerization, using multi-stage builds for minimal production images and orchestration for managing multi-container environments.
Features
- Clean Architecture Implementations - Provides a standardized implementation of clean architecture for decoupling business logic in Go applications.
- Dependency Inversion Patterns - Implements a Clean Architecture where high-level business logic depends on abstractions rather than concrete infrastructure.
- Go and Ruby Boilerplates - Provides a comprehensive starter kit for building Go services with dependency injection and domain-driven design.
- Repository Patterns - Decouples domain logic from specific data storage implementations through the repository pattern.
- Clean Architecture Frameworks - Provides a foundational template that enforces the separation of business logic from infrastructure and presentation layers.
- Internal Package Encapsulation - Implements internal package restrictions to ensure implementation details remain hidden from external consumers.
- Package Visibility Restrictions - Enforces architectural boundaries by restricting external access to internal implementation packages.
- Storage Abstraction Layers - Decouples application logic from storage backends using interface-driven abstraction layers.
- Dependency Mocking - Uses simulated implementations of external dependencies to verify business logic in isolation.
- Business Logic Isolation - Separates application business logic from the user interface and external drivers to enable independent testing.
- Production Builds - Builds optimized, production-ready container images from configuration files.
- Multi-Stage Container Builds - Uses multi-stage Docker builds to separate the build environment from the minimal runtime image.
- Containerized Application Deployments - Packages Go applications into lightweight production images with orchestrated infrastructure dependencies.
- Go Development Workflows - Implements a development lifecycle optimized for Go with automated reloading and static analysis.
- Static Analysis - Integrates static analysis linters to identify bugs and maintain consistent coding standards.
- Service Isolation Utilities - Provides utilities to verify service behavior independently of external databases or third-party APIs.
- Go Testing Frameworks - Implements a testing setup utilizing mock dependencies to verify business logic in isolation.
- Isolated Functionality Testing - Verifies core application behavior in isolated environments without requiring active database or server connections.
- Parallel Test Execution - Executes test suites using parallelization and provides detailed coverage reporting.
- Unit Testing - Verifies the smallest testable parts of the application in isolation using mock objects.
- Project Scaffolding - Implementation of clean architecture patterns.
