Go clean architecture template

This is a template for Go project with clean architecture.

Folder structure

go-clean-template
├── cmd
│   ├── httpserver
│   └── migrate
├── entity/domain/model
├── handler //as controller
│   └── httpserver
│       ├── middleware
│       ├── model
│       ├── options.go
│       ├── server.go
│       └── *_handler.go //handle request to client
├── infras
│   ├── paymentsvc //call API to payment service provider
│   ├── notification //push noti
│   └── postgrestore
│       ├── schema
│       ├── postgresql.go //contains actions to connect DB
│       └── *_repo.go //implement repository interfaces
├── migrations  //contains migration files
├── pkg // contains common packages
│   ├── apperror
│   ├── config
│   ├── constant
│   ├── logger
│   ├── sentry
│   └── validation
├── tools
│   ├── compose
│   └── pre-commit
└── usecase
    ├── mocks //contains mock files used for unit testing
    ├── interface.go //contains all interfaces
    └── ... //specific usecases

Development

Init local environment

1. Copy file .env.example and rename to .env

2. Update env vars to fit your local

3. Start local services

   make local-db

4. Run the server

   make run

5. Unit test

   make test

6. Generate Mock

    make mock

Linting

make lint

Create new migration file

sql-migrate new -env="development" Init-database

• Result: Created migration migrations/20240704092049-Init-database.sql

Then run migration:

make db/migrate