jenrinaldo/golang-monolithic-boilerplate

Go DDD example application. Complete project to show how to apply DDD, Monolithic Architecture using docker ,mongodb ,redis ,gin and paseto.

Golang Monolithic Boilerplate

Golang Monolithic Boilerplate using Domain Driven Design handles authentication and authorization, and beside of this features, It also handles user CRUD using :

• Gin Gonic
• MongoDB
• Redis
• Docker
• Paseto

Terminology

• User — User is the main entity of this microservice which contain the primary information of user, all the actions of user list below

• Authentication — Each user can register and login in the system and take advantage of our platform, therefore we assign a token for handling this operation. (PASETO)

• Authorization — Each user access defined permissions and take actions on specific entities, therefore we control this permissions through role based authorization.

• Permission — One the main entities of this microservice and it is key value pair to know which role has which permission.

• Role — Each user can have one role, and each role can have multiple permissions, we handle user's access to Polaris project

Structure of the Code

 ┌───┐
 │ / │
 └─┬─┘
   │
   ├───────▶ Common ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ Configuration(s) (default values, env, middleware, token)
   │
   ├───────▶ Components ─ ─ ─ ─ All Components have Request ,Response ,Controller ,Service and Repository
   │                   │ 
   │                   └──┬──▶ Auth ─ ─ ─ ─ Login User and NewAccessToken
   │                      │
   │                      ├──▶ AuthUser ─ ─ ─ ─ Logout User
   │                      │ 
   │                      ├──▶ Permission ─ ─ ─ ─ Permission List
   │                      │
   │                      ├──▶ Role ─ ─ ─ ─ Create ,Reade ,Update Roles
   │                      │
   │                      ├──▶ RolePermission ─ ─ ─ ─ Attach and Detach Permission to Role
   │                      │
   │                      ├──▶ Ticket ─ ─ ─ ─ Create New User Ticket
   │                      │
   │                      ├──▶ User ─ ─ ─ ─ Create ,Reade ,Update User 
   │                      │
   │                      └──▶ UserRole ─ ─ ─ ─ Attach and Detach Role to User
   │
   ├───────▶ Docs ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ Swagger Files
   │
   ├───────▶ Router ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ 
   │
   ├───────▶ Test ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ ─ Config Testing Database

Setting up the environment

The system needs to have a database (mongodb).

You have to complete your .env file based on the .test.env template file provided within the root directory of the project.

You can run the docker environment

For start Mongodb :

$ make createdb

For start Redis :

$ make redis

For start Swagger :

$ make swagger

For start server :

$ make server