Express Rest Api Clean Architecture

The following is a folder pattern for express rest api starterkit structure pattern that I usually use, so if you are interested in the pattern I made, you can use it if you think it's good.

Table Of Content

• What Are The Benefits
• Folder Structure Pattern
• Folder Status And Description
  • Test
  • Configs
  • Di
  • Databases
  • Dto
  • Helpers
  • Interfaces
  • Libs
  • Middlewares
  • Models
  • Routes
  • Controllers
  • Services
  • Templates
  • Crons
• Command
  • Application Lifecycle
  • Docker Lifecycle
  • Database Lifecycle

What Are The Benefits ?

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

Folder Structure Pattern

├── tests
│   └── test.user.spec.ts
├── di
│   └── di.user.ts
├── dto
│   └── dto.user.ts
└── helpers
│   └── helper.apiResponse.ts
└── middlewares
│   └── middleware.auth.ts
└── interfaces
│   └── interface.user.ts
└── models
│   └── model.user.ts
└── controllers
│   └── controllers.user.ts
└── services
│   └── service.user.ts
└── libs
│   └── lib.jwt.ts
└── configs
│   └── pm2.config.js
└── templates
│   └── activation.template.ejs
└── databases
│   └── migrations
│   │     └── user_20210913.go // generate auto by cli using third party library
│   └── seeds
│   │     └── user_20210913.go // generate auto by cli using third party library

Folder Status And Description

• Tests

• Configs

• Di

• Dto

• Helpers

• Interfaces

• Libs

• Middlewares

• Models

• Controllers

• Routes

• Services

• Templates

• Crons

• Databases

Command

• Application Lifecycle

  • Install node modules

  $ npm install

  • Build application

  $ npm run build || make build

  • Start application in development

  $ npm run dev | make dev

  • Start application in production

  $ npm run start || make start

  • Start application in production on docker

  $ npm run start:docker || make startdoc

  • Testing application

  $ npm run test || make test

  • Testing application include coverage

  $ npm run start:cov || make testcov

• 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

• Database Lifecycle

  • Create new migration database

  $ npm run orm:make <migration name> || make ormake name=<migration name>

  • Run migration database to latest

  $ npm run orm:latest || make ormig type=latest

  • Run migration database to rollback

  $ npm run orm:rollback || make ormig type=rollback

  • Run show list all migration

  $ npm run orm:list || make list

  • Check valid TypeORM Config

  $ npm run seed:config || make orscon

  • Run seed database and migration

  $ npm run seed:run || make orsrun type=run

  • Run seed database and migration + Rollback

  $ npm run seed:runrollmig || make orsrun type=runrollmig

BACK TO TOP