Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/zetsux/gin-gorm-clean-starter

๐Ÿงน A clean architecture starter template for REST API using Gin and GORM (Golang)
https://github.com/zetsux/gin-gorm-clean-starter

api clean-architecture gin golang gorm rest-api starter starter-template template

Last synced: about 2 months ago
JSON representation

๐Ÿงน A clean architecture starter template for REST API using Gin and GORM (Golang)

Awesome Lists containing this project

README

        

# Gin GORM Template (Clean Architecture)

## Contents

- [Description](#description)
- [Architecture](#architecture)

- [Explanation (EN)](#explanation-en)
- [Explanation (ID)](#explanation-id)

- [Pre-requisites](#pre-requisites)

- [PostgreSQL Requirements](#postgresql-requirements)
- [GitHooks Requirements](#githooks-requirements)

- [How to Run?](#how-to-run)
- [API Documentation (Postman)](#api-documentation-postman)

## Description

A Clean Architecture starter template for projects using Gin (Golang) and PostgreSQL, with GORM as the ORM.

## Architecture

```
/backend
โ”‚
โ”œโ”€โ”€ /api
โ”‚ โ””โ”€โ”€ /v1
โ”‚ โ”œโ”€โ”€ /controller
โ”‚ โ”‚ โ”œโ”€โ”€ user.go
โ”‚ โ”‚ โ””โ”€โ”€ etc
โ”‚ โ””โ”€โ”€ /router
โ”‚ โ”œโ”€โ”€ user.go
โ”‚ โ””โ”€โ”€ etc
โ”‚
โ”œโ”€โ”€ /common
โ”‚ โ”œโ”€โ”€ /base
โ”‚ โ”‚ โ””โ”€โ”€ model.go
โ”‚ โ”‚ โ””โ”€โ”€ request.go
โ”‚ โ”‚ โ””โ”€โ”€ response.go
โ”‚ โ”‚ โ””โ”€โ”€ etc
โ”‚ โ”œโ”€โ”€ /constant
โ”‚ โ”‚ โ””โ”€โ”€ default.go
โ”‚ โ”‚ โ””โ”€โ”€ enums.go
โ”‚ โ”‚ โ””โ”€โ”€ etc
โ”‚ โ”œโ”€โ”€ /middleware
โ”‚ โ”‚ โ””โ”€โ”€ authentication.go
โ”‚ โ”‚ โ””โ”€โ”€ cors.go
โ”‚ โ”‚ โ””โ”€โ”€ authorization.go
โ”‚ โ”‚ โ””โ”€โ”€ etc
โ”‚ โ””โ”€โ”€ /util
โ”‚ โ””โ”€โ”€ bcrypt.go
โ”‚ โ””โ”€โ”€ file.go
โ”‚ โ””โ”€โ”€ etc
โ”‚
โ”œโ”€โ”€ /config
โ”‚ โ”œโ”€โ”€ db.go
โ”‚ โ””โ”€โ”€ etc
โ”‚
โ”œโ”€โ”€ /core
โ”‚ โ”œโ”€โ”€ /entity
โ”‚ โ”‚ โ””โ”€โ”€ user.go
โ”‚ โ”‚ โ””โ”€โ”€ etc
โ”‚ โ”œโ”€โ”€ /helper
โ”‚ โ”‚ โ”œโ”€โ”€ /dto
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ user.go
โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ etc
โ”‚ โ”‚ โ”œโ”€โ”€ /errors
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ other.go
โ”‚ โ”‚ โ”‚ โ”œโ”€โ”€ user.go
โ”‚ โ”‚ โ”‚ โ””โ”€โ”€ etc
โ”‚ โ”‚ โ””โ”€โ”€ /messages
โ”‚ โ”‚ โ”œโ”€โ”€ file.go
โ”‚ โ”‚ โ”œโ”€โ”€ user.go
โ”‚ โ”‚ โ””โ”€โ”€ etc
โ”‚ โ”œโ”€โ”€ /repository
โ”‚ โ”‚ โ””โ”€โ”€ user.go
โ”‚ โ”‚ โ””โ”€โ”€ etc
โ”‚ โ””โ”€โ”€ /service
โ”‚ โ”œโ”€โ”€ user.go
โ”‚ โ””โ”€โ”€ etc
โ”‚
โ”œโ”€โ”€ /database
โ”‚ โ”œโ”€โ”€ /seeder
โ”‚ โ”‚ โ””โ”€โ”€ user.go
โ”‚ โ”‚ โ””โ”€โ”€ etc
โ”‚ โ””โ”€โ”€ migrator.go
โ”‚
โ””โ”€โ”€ main.go
```

### Explanation (EN)

- `/api/v1` : The directory for things related to API like all available endpoints (route) and the handlers for each endpoints (controller). Subdirectory `/v1` is used for easy version control in case of several development phase.

- `/controller` : The directory for things related to the Controller layer which is the part of program that handle requests and return responses.
- `/router` : The directory for things related with routing. Therefore filled with every available supported routes / endpoints along with the request method and used middleware.

- `/common` : The directory for common things that are frequently used all over the architectures.

- `/base` : The directory for base things such as variables, constants, and functions to be used in other directories. It consists of things like response, request, and model base structure.
- `/middleware` : The directory for Middlewares which are mechanism that intercept a HTTP request and response process before handled directly by the controller of an endpoint.
- `/util` : The directory to store utility / helper functions that can be used in other directories.

- `/config` : The directory for things related to program configuration like database configuration.

- `/core` : The directory for things related to the core side of the Back End. It consists of things like business logic, entities, and database interaction.

- `/entity` : The directory for things related to entities / models which are available on the database via migration that are represented by structs.
- `/helper` : The directory to store things that will be used to help the Back End side operates. It consist of useful things such as DTOs, error variables, and message constants.

- `/dto` : The directory to store DTO (Data Transfer Object) which is a placeholder for other objects, mainly to store data for requests and responses.
- `/errors` : The directory to store stores error variables for each entity and other needs.
- `/messages` : The directory to store message constants for each entity.

- `/repository` : The directory for things related to the Repository layer which is the layer that is responsible to interact directly with the database.
- `/service` : The directory for things related to the Service layer which is the layer that is responsible for the flow / business logic of the app.

- `/database`: The directory for things related to the database for example migrations and seeders.

- `/seeder` : The directory for things related to database seeding for each entity.

### Explanation (ID)

- `/api/v1` : Directory yang berisi berbagai hal yang berkaitan dengan API seperti daftar endpoint yang disediakan (route) serta handler (controller) dari setiap endpointnya. Subdirectory `/v1` sendiri digunakan untuk menyimpan beberapa versi dari API yang dapat ditambahkan sesuai kebutuhan.

- `/controller` : Directory untuk menyimpan hal-hal terkait dengan Controller yang merupakan bagian dari program yang berfungsi menerima request dan memberikan response.
- `/router` : Directory untuk menyimpan hal-hal yang terkait dengan routing. Berisikan routes atau endpoints yang didukung beserta dengan metode requestnya.

- `/common` : Directory yang berisi berbagai hal umum untuk digunakan di seluruh directory.

- `/base` : Directory yang berisi berbagai variabel, konstanta, maupun fungsi standar untuk digunakan di berbagai directory lainnya seperti response, request, error, struktur dasar model, konstanta, dan lain-lain.
- `/middleware` : Directory untuk menyimpan Middleware yang merupakan mekanisme yang menengahi proses HTTP request dan response sebelum ditangani secara langsung oleh controller setiap route.
- `/util` : Directory untuk kode terkait fungsi-fungsi utilitas atau pembantu lainnya yang bisa digunakan di berbagai directory lainnya.

- `/config` : Directory yang berisi hal terkait konfigurasi aplikasi. Contohnya seperti konfigurasi database.

- `/core` : Directory yang berisi berbagai hal yang berkaitan dengan sisi inti dari Back End. Meliputi business logic, entitas, maupun interaksi dengan database.

- `/entity` : Directory untuk menyimpan entitas atau model yang digunakan baik di migrasi maupun di aplikasi.
- `/helper` : The directory to store things that will be used to help the Back End side operates. It consist of useful things such as DTOs, error variables, and message constants.

- `/dto` : Directory untuk menyimpan DTO (Data Transfer Object) adalah placeholder untuk suatu object lain yang digunakan untuk menampung data request dan response.
- `/errors` : Directory untuk menyimpan variabel-variabel error untuk baik yang spesifik untuk setiap entitas maupun yang lain.
- `/messages` : Directory untuk menyimpan konstanta pesan untuk digunakan dalam response API.

- `/repository` : Directory untuk menyimpan hal-hal terkait Repository yang merupakan lapisan yang berhubungan langsung dengan database.
- `/service` : Directory untuk menyimpan hal-hal terkait Service yang merupakan lapisan yang bertanggung jawab menangani alur atau logika bisnis aplikasi.

- `/database`: Directory untuk menyimpan hal-hal terkait migrasi dan juga seeding terhadap database.

- `/seeder` : Directory untuk menyimpan hal-hal yang diperlukan untuk seeding terhadap database dengan dipisahkan sesuai entitas.

## Pre-requisites

### PostgreSQL Requirements

1. Create the database in PostgreSQL with the name equal to the value of DB_NAME in `.env`
2. Use the command `CREATE EXTENSION IF NOT EXISTS "uuid-ossp";` on the database terminal

### GitHooks Requirements

> Note : GitHooks is not mandatory for this starter. Only do the steps below if you want to apply & use it.

1. Install golangci-lint as the linters aggregator for pre-commit linting by executing `go install github.com/golangci/golangci-lint@latest`. Alternatively, you can follow the recommended method, which involves installing the binary from the [official source](https://golangci-lint.run/usage/install/#binaries)
2. Install commitlint as the conventional commit message checker by executing `go install github.com/conventionalcommit/commitlint@latest`. Alternatively, you can follow the recommended method, which involves installing the binary from the [official source](https://github.com/conventionalcommit/commitlint/releases)
3. Configure your git's hooks path to be linked to the `.githooks` directory on this repository by executing `git config core.hooksPath .githooks`

## How to Run?

1. Use the command `make tidy` (or use `go mod tidy` instead, if `make` is unable to be used) to adjust the dependencies accordingly
2. Use the command `make run` (or use `go run main.go` instead, if `make` is unable to be used) to run the application

## API Documentation (Postman)

Link : https://documenter.getpostman.com/view/25087235/2s9YXfcizj