Awesome

Golang Clean Architecture

The following is a folder structure pattern that I usually use, although I don't use all of them because of the project I'm working on only small projects that are not too big, so if you are interested in the pattern I made, you can use it if you think it's good, check this link for new update for this architecture here.

Table Of Content

• What Are The Benefits
• Flow Diagram
• Folder Structure Pattern
• Folder Status And Description
  • Test
  • Docker
  • Handlers
  • Repositorys
  • Services
  • Helpers
  • Middlewares
  • Models
  • Routes
  • Schemas
  • Templates
  • Pkg
  • Scripts
  • Configs
  • Cmd
  • Datbases
• Command
  • Application Lifecycle
  • Docker Lifecycle

What Are The Benefits ?

• Easy to maintance
• Easy to scalable you project
• Readable code
• Suitable for large projects or small projects
• Easy to understand for junior or senior
• And more

Flow Diagram

Folder Structure Pattern

├── tests
│   └── test.auth_test.go
│   └── test.student_test.go
└── docker
│   └── swagger
│   │     └── Dockerfile
│   │     └── openapi.yml
│   └── mysql
│   │     └── Dockerfile
│   │     └── mysql.cnf
│   └── golang
│   │     └── Dockerfile
├── handlers
│   └── auth
│   │     └── handler.login.go
│   │     └── handler.register.go
│   └── student
│   │     └── handler.create.go
│   │     └── handler.create.go
└── repositorys
│   └── auth
│   │     └── repository.login.go
│   │     └── repository.register.go
│   └── student
│   │     └── repository.create.go
│   │     └── repository.create.go
└── services
│   └── auth
│   │     └── services.login.go
│   │     └── services.register.go
│   └── student
│   │     └── services.create.go
│   │     └── services.create.go
└── helpers
│   └── helper.apiResponse.go
│   └── helper.randomString.go.go
└── middlewares
│   └── middleware.auth.go
│   └── middleware.role.go.go
└── models
│   └── model.auth.go
│   └── model.student.go.go
└── routes
│   └── route.auth.go
│   └── route.student.go
└── schemas
│   └── schema.auth.go
│   └── schema.student.go.go
└── templates
│   └── template.register.html
│   └── template.activation.html
└── pkg
│   └── pkg.jwt.go
│   └── pkg.bcrypt.go
│   └── pkg.cron.go
└── scripts
│   └── script.gcpRunner.sh
│   └── script.awsRunner.sh
└── configs
│   └── openapi.yml
│   └── serverless.yml
└── cmd
│   └── cmd.pgMigration.go
│   └── cmd.pgSeeds.go
└── crons
│   └── cron.autoDeleteLogs.go
│   └── cron.emailBlast.go
└── databases
│   └── migrations
│   │     └── auth_20210913.go //generate auto by cli using third party library
│   │     └── student_20210913.go //generate auto by cli using third party library
│   └── seeds
│   │     └── auth_20210913.go //generate auto by cli using third party library
│   │     └── student_20210913.go //generate auto by cli using third party library
│   └── sql
│   │     └── database.auth.sql
│   │     └── database.student.sql

Folder Status And Description

• Tests

• Docker

• Handlers

• Repositorys

• Services

• Helpers

• Middlewares

• Models

• Routes

• Schemas

• Templates

• Pkg

• Scripts

• Configs

• Cmd

• Crons

• Databases

Command

• Application Lifecycle

  • Install node modules

  $ go get . || go mod || make goinstall
  

  • Build application

  $ go build -o main || make goprod
  

  • Start application in development

  $ go run main.go | make godev
  

  • Test application

  $ go test main.go main_test.go || make gotest
  

• Docker Lifecycle

  • Build container

  $ docker-compose build | make dcb
  

  • Run container with flags

  $ docker-compose up -d --<flags name> | make dcu f=<flags name>
  

  • Run container build with flags

  $ docker-compose up -d --build --<flags name> | make dcubf f=<flags name>
  

  • Run container

  $ docker-compose up -d --build | make dcu
  

  • Stop container

  $ docker-compose down | make dcd