Golang Microservice Template 🚀

A scalable and maintainable microservice template in Go, inspired by the NestJS framework and built on Clean Architecture principles. Perfect for handling complex domain-driven projects with robust design and separation of concerns. Ready for both MongoDB and PostgreSQL out of the box! 💻⚡

Project Structure

project/
├── migrations/                      # Migration scripts for PostgreSQL
│   └── user_migration.sql
│   └── order_migration.sql
├── main.go                          # Application entry point
├── go.mod
├── src/                             # Source code folder (contains all the layers)
│   ├── domain/
│   │   └── aggregates/
│   │       ├── user.go              # Business logic for User (Domain model)
│   │       └── order.go             # Business logic for Order (Domain model)
│   ├── application/
│   │   └── service/
│   │       ├── user_service.go      # Business logic for User
│   │       └── order_service.go     # Business logic for Order
│   ├── infrastructure/
│   │   ├── db/
│   │   │   ├── db.go                # General Database connection
│   │   │   └── mongo-db.go          # MongoDB connection logic
│   │   │   └── postgres-db.go       # PostgreSQL connection logic
│   │   ├── entity/
│   │   │   ├── user.go              # MongoDB User entity
│   │   │   └── order.go             # PostgreSQL Order entity
│   │   ├── repository/
│   │   │   ├── user_repository_impl.go  # MongoDB UserRepository implementation
│   │   │   └── order_repository_impl.go # PostgreSQL OrderRepository implementation
│   ├── interfaces/
│   │   └── handlers/
│   │       ├── user_handler.go      # HTTP handler for User
│   │       └── order_handler.go     # HTTP handler for Order
│   ├── app_module/                  # Central module initialization
│   │   └── app_module.go            # Initializes repositories and services
│   ├── helpers/                     # Common utility functions
│   │   └── uuid_helper.go           # Common UUID generator
│   │   └── string_helpers.go        # String manipulation helpers        

Layers Explained

• Domain Layer: Contains the core business models and domain logic. It defines entities and their relationships, encapsulating the business rules.

• Application Layer: Holds the business logic and use cases. It coordinates the flow of data between the domain and infrastructure layers, processing requests and responses.

• Infrastructure Layer: Manages data access and external integrations (e.g., database interactions, third-party APIs). It provides concrete implementations for the repository interfaces defined in the domain layer.

• Interface Layer: Contains HTTP handlers for routing incoming requests and managing responses. It may also include Data Transfer Objects (DTOs) for structured data interchange between client and server.

Getting Started

Prerequisites

• Go 1.XX or higher
• Dependencies specified in go.mod

Installation

1. Clone the repository:

   git clone <repository-url>
   cd project

2. Install dependencies:

   go mod tidy

Running the Application

To start the application, run:

go run main.go

Testing

To run tests, execute:

go test ./...

Contributing

Contributions are welcome! Please open an issue or submit a pull request for any improvements.

License

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

Acknowledgments

• Clean Architecture by Robert C. Martin
• Golang Documentation