templatebe

A monorepo built using Golang and adhering to Clean Architecture principles. This template is designed to help developers create a scalable and maintainable project with multiple service with ease. Here is the benefits to use monorepo https://monorepo.tools/. Our template also includes a core library for sharing dependencies between services, making it easier to manage, refactor and maintain the project while not breaking the microservice design pattern. We suggest using Golang module working space https://go.dev/doc/tutorial/workspaces.

Prerequisite

- Golang 1.20 or newer
- Docker
- wire

Getting Started (Deployment approach)

1. init go module working space, run (only 1st time)

    go work init
    go work use ./corelib
    go work use -r ./service/*

2. sync dependency between module, run

    go work sync

3. start docker compose

    cd ./docker
    docker-compose up --build -d

4. drop and create database, run

    docker exec -i postgres psql -U postgres -c "drop database if exists postgres_template_be" && \
    docker exec -i postgres psql -U postgres -c "create database postgres_template_be"

5. migrate database by executing the sql files in repository in all services

Getting Started (Manual approach)

1. init go module working space, run (only 1st time)

    go work init
    go work use ./corelib
    go work use -r ./service/*

2. sync dependency between module, run

    go work sync

3. start postgres, run

    docker run --rm -p 5432:5432 -e POSTGRES_PASSWORD=postgres --name postgres postgres:15.2-alpine

4. drop and create database, run

    docker exec -i postgres psql -U postgres -c "drop database if exists postgres_template_be" && \
    docker exec -i postgres psql -U postgres -c "create database postgres_template_be"

5. migrate database by executing the sql files in migration folder in all services or use goose cmd by run

    cd ./service/bff/migration
    goose postgres "user=postgres password=postgres dbname=postgres_template_be sslmode=disable" up

6. start service

    cd ./service/bff
    go run ./cmd/serve

Generate migration file

    cd ./service/bff/migration
    goose create <file_name> sql

Generating sqlc

    go install github.com/kyleconroy/sqlc/cmd/sqlc@latest
    sqlc generate

Inject Dependency

1. install wire

    go install github.com/google/wire/cmd/wire@latest

2. run wire

    cd ./service/bff/cmd/serve
    wire

Docker

    cd ./service/bff
    docker build -t serve .
    docker run serve

How to update dependency of corelib

run

    go mod tidy

Layout

- corelib: (core library) contains packages that are rarely changed and can be used across repos in service folder
- docker: contains docker compose file
- service: contains all repos of microservices
    - bff: (backend for frontend service) 
        - cmd: (command) contains multiple main.go file
        - config: contains config.yaml file
        - internal: contains packages that is usually changed
            - api: contains handler that is used for parsing request and return response
            - config: contains config struct that read from config.yaml
            - controller: contains business logics and repository interfaces
            - domain: contains database struct
            - model: contains request and response struct of the api
            - repository: contains structs that implement interfaces that is needed by controller 
            - server: contains server struct, manage server middleware and route names here

*api will only send/receive data to controller in struct in the model package to eliminate dependency.
*controller will only send/receive data to repository in struct in the domain package to eliminate dependency.

Design pattern

- Clean architecture
- Hexagonal architecture (port & adapter)

API convention

- RESTful API
- route name: hyphen case
- json body: camelCase (smaller size than snake case)
- query param: camelCase (smaller size than snake case)
- path param: camelCase (smaller size than snake case)
- time: ISO8601 in UTC

Database convention

- table name: lower + snake case, in plural
- enum: lower + snake case
- time: ISO8601 in UTC

Application convention

- folder name: don't use camel and snake case. It should be short and clearly and it should not duplicate with the variable name that is tend to be used in application (Go convention)
- unique name such as "productId" should be "productID"
- https://github.com/uber-go/guide/blob/master/style.md

Testing

when interface in controller has changed, run

    cd ./service/bff
    mockgen -source=./internal/controller/customer.go -destination=./internal/repository/mockrepo/customer.go -package=mockrepo