github.com/pnnguyen58/go-project-layout

go-project-layout

Description

• This project is for golang project template

Prerequisites

• Clean architecture
• Hexagonal architecture
• Temporal IO

Technologies and Frameworks

• golang 1.20
• temporal 1.24

Directory structure

📁 go-project-layout
|__ 📁 api
|__ 📁 build
    |__ 📁 ci
    |__ 📁 packages
|__ 📁 cmd
    |__ 📁 app
    |__ 📁 workers
|__ 📁 configs
|__ 📁 deploy 
    |__ 📁 docker-compose
    |__ 📁 kubernetes
    |__ 📁 terraform
|__ 📁 docs
|__ 📁 internal 
    |__ 📁 activities // temporal activities
    |__ 📁 app // application layer
    |__ 📁 models // entitiy layer
    |__ 📁 repositories // database repositories
    |__ 📁 workflows // temporal workflows
    |__ 📁 defined // types and constants
|__ 📁 pkg
    |__ 📁 clients
    |__ 📁 google
    |__ 📁 logger
    |__ 📁 persistence
    |__ 📁 proto
    |__ 📁 proto_generated
|__ 📁 scripts
    |__ 📁 app
    |__ 📁 workers
    |__ docker-compose.yml
|__ 📁 tests
|__ 📁 infra
|__ Makefile
|__ go.mod
|__ go.sum
|__ README.md

How to run local

• Build and run: make buildup
• Stop and reset volume: make reset

How to test

Monitoring

• Workflow status: http://localhost:8080

Conceptual model

TODO tasks

• Add a policy check to make sure that the customers can view them own loan only.
• Implement more unit tests
• Implement exceed amount repayment
• Fix docker network and wait dependencies healthy
• Implement error abstract

References

• Project layout: https://github.com/golang-standards/project-layout
• Transcoding of HTTP/JSON to gRPC: https://adevait.com/go/transcoding-of-http-json-to-grpc-using-go
• Workflow framework: https://docs.temporal.io/
• Clean architecture: https://blog.cleancoder.com/uncle-bob/2012/08/13/the-clean-architecture.html