njustice4all / nestjs-clean-architecture-demo

An example of clean architecture implementation with NestJS

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

nestjs-clean-architecture-demo

Build Status

An example of clean architecture with NestJS

Foreword

This application is designed using a Clean Architecture pattern (also known as Hexagonal Architecture). Therefore SOLID principles are used in code, especially the Dependency Inversion Principle (do not mix up with the classic dependency injection in NestJS for example).

Concretely, there are 3 main packages: domain, use_cases and infrastructure. These packages have to respect these rules:

  • domain contains the business code and its logic, and has no outward dependency: nor on frameworks (NestJS for example), nor on use_cases or infrastructure packages.
  • use_cases is like a conductor. It will depend only on domain package to execute business logic. use_cases should not have any dependencies on infrastructure.
  • infrastructure contains all the technical details, configuration, implementations (database, web services, etc.), and must not contain any business logic. infrastructure has dependencies on domain, use_cases and frameworks.

Install

npm install

Test

npm test

Run

npm run typeorm:migration:run
npm run start:dev

About

An example of clean architecture implementation with NestJS


Languages

Language:TypeScript 93.7%Language:Shell 3.3%Language:JavaScript 3.0%