Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/restuwahyu13/go-clean-architecture

Example go clean architecture folder pattern
https://github.com/restuwahyu13/go-clean-architecture

clean-architecture folder-structure golang google-api

Last synced: about 2 months ago
JSON representation

Example go clean architecture folder pattern

Host: GitHub
URL: https://github.com/restuwahyu13/go-clean-architecture
Owner: restuwahyu13
Created: 2021-10-11T19:07:06.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-12-17T14:07:57.000Z (almost 2 years ago)
Last Synced: 2024-05-15T06:35:41.545Z (4 months ago)
Topics: clean-architecture, folder-structure, golang, google-api
Language: Go
Homepage:
Size: 226 KB
Stars: 117
Watchers: 2
Forks: 36
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

awesome-made-by-indonesian - Golang Clean Architecture - `Example go clean architecture folder pattern` *by [Restu Wahyu Saputra](https://github.com/restuwahyu13)* (G)
made-in-indonesia - Golang Clean Architecture - `Example go clean architecture folder pattern` *by [Restu Wahyu Saputra](https://github.com/restuwahyu13)* (G)

README

# 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](https://github.com/restuwahyu13/go-trakteer-api).

## Table Of Content

- [What Are The Benefits](#what-are-the-benefits-)
- [Flow Diagram](#flow-diagram)
- [Folder Structure Pattern](#folder-structure-pattern)
- [Folder Status And Description](#folder-status-and-description)
+ [Test](#tests)
+ [Docker](#docker)
+ [Handlers](#handlers)
+ [Repositorys](#repositorys)
+ [Services](#services)
+ [Helpers](#helpers)
+ [Middlewares](#middlewares)
+ [Models](#models)
+ [Routes](#routes)
+ [Schemas](#schemas)
+ [Templates](#templates)
+ [Pkg](#pkg)
+ [Scripts](#scripts)
+ [Configs](#configs)
+ [Cmd](#cmd)
+ [Datbases](#databases)
- [Command](#command)
+ [Application Lifecycle ](#application-lifecycle)
+ [Docker Lifecycle](#docker-lifecycle)

## What Are The Benefits ?

- [x] Easy to maintance
- [x] Easy to scalable you project
- [x] Readable code
- [x] Suitable for large projects or small projects
- [x] Easy to understand for junior or senior
- [x] And more

## Flow Diagram

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
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Tests* | *Optional* | *A collection of functions used to create a series of tests or run a test, be it unit testing or integration testing, which will later be used for the application itself.* |

- #### Docker
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Docker* | *Optional* | *A collection of functions that are used to create a container for the application that has been created, which will later be used for the application itself.* |

- #### Handlers
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Hanlders* | *Optional* | *A collection of functions used to handle all requests passed down from the client via routing, where later those requests will be forwarded to services and repositories for further processing, which will later be used for the application itself.* |

- #### Repositorys
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Repositorys* | *Required* | *A collection of functions used to handle all requests given from handlers and services, which then those requests will be used to communicate with the database, which will later be used for the application itself.* |

- #### Services
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Services* | *Required* | *A collection of functions that are used to forward requests given by handlers to repositories, which will later be used for the application itself.* |

- #### Helpers
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Helpers* | *Optional* | *A collection of functions used to create utilities for application purposes, such as customError or customResponse, which will later be used for the application itself.* |

- #### Middlewares
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Middlewares* | *Optional* | *A collection of functions that are used as a service for HTTP Requests such as authJWt, authRole, customLogger whether used per-route or used globally without the need to use them in each route, which will later be used for the application itself.* |

- #### Models
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Models* | *Required* | *A collection of functions used to represent the table structure in a database, which will later be used for the application itself.* |

- #### Routes
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Routes* | *Required* | *A collection of endpoints or addresses from the server itself, which is used for communication lines between the client and the server, which will later be used for the application itself.* |

- #### Schemas
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| *Schemas* | *Required* | *A collection of functions that are used to represent the desired request structure, according to the requests required by the database, which will later be used for the application itself.* |

- #### Templates
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Templates* | *Optional* | *A collection of functions that are used to output HTML code into emails to be used as templates, which will later be used for purposes such as activationCode or resetPassword, which will later be used for the application itself.* |

- #### Pkg
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Pkg* | *Optional* | *A collection of functions that are used for the purpose of customizing a library into a separate function, which will later be used for the application itself.* |

- #### Scripts
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Scripts* | *Optional* | *A collection of functions that are used to trigger a function from another function, such as importing a database from a .sql file into a container using docker, which will later be used for the application itself.* |

- #### Configs
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Configs* | *Optional* | *A collection of functions that contains all the configurations related to the application needs, such as .env or serverless.yml, which will later be used for the application itself.* |

- #### Cmd
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Cmd* | *Optional* | *A collection of functions that are used to interact directly with the terminal, usually used for purposes such as running database migrations or seeds, which will later be used for the application itself.* |

- #### Crons
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Crons* | *Optional* | *A collection of functions that are used to trigger a desired function, according to the time specified by the user, which will later be used for the application itself.* |

- #### Databases
| **Folder Name** | **Folder Status** | **Description** |
| --------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Databases* | *Optional* | *A collection of functions used to create migrations or seeds for the database, which will later be used for the application itself.* |

## Command

- ### Application Lifecycle

- Install node modules

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

- Build application

```sh
$ go build -o main || make goprod
```

- Start application in development

```sh
$ go run main.go | make godev
```

- Test application

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

* ### Docker Lifecycle

- Build container

```sh
$ docker-compose build | make dcb
```

- Run container with flags

```sh
$ docker-compose up -d -- | make dcu f=
```

- Run container build with flags

```sh
$ docker-compose up -d --build -- | make dcubf f=
```

- Run container

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

- Stop container

```sh
$ docker-compose down | make dcd
```

BACK TO TOP