Node Clean Architecture Typescript Boilerplate

A Node.js webserver template implementing Clean Architecture concepts using Typescript

Summary

This project is based on Uncle Bob's Clean Architecture ideas. It's really recommended to read his blog post about it and, maybe, his book too to have deep understanding about the benefits in using it. This project also fits perfectly the Ports & Adapters aka Hexagonal Architecture.

Note the arrows in the image pointing inwards. They demonstrate the Dependency Rule: "Nothing in an inner circle can know anything at all about something in an outer circle". This project shows how you can implement it in a real world scenario. Each layer should expose its Ports (interfaces), so outer layers can understand the behavior of the dependency that needs to be injected. An implemented port is called Adapter. For convenience, all abstract classes in this project starting with an extra "I" are ports and extend the IPort interface (directly or indirectly). All classes that implement a Port, are Adapters.

Project Structure

The project's main entry point is inside the src folder:

• domain: The red and yellow segments in the Clean Architecture refers to the business rules, the core of your system. This folder will contain the heart of your application. Rather than having two separate layers for Use Cases and Entities, I decided to consider all as domain.
• interface-adapters: Represented by the green layer in the image. It's where we build our app. In this example project, contains the webserver logic, controllers and presentation.
• infrastructure: Represented by the blue layer in the image. It's where we adapt all the external dependencies such as libraries, databases and I/O processes following the Port contract provided by inner layers.

Project Features

• Node LTS version support
• Typescript compiler and linter
• Dependency Injection (please check src/infrastructure/DependencyInjection)
• Import boundaries control. Eslint will ensure that you're following the Dependency Rule.
• Unit and Integration tests

Installation and Usage

Clone this repository to your local machine

$ git clone https://github.com/maiquelcraash/node-clean-architecture-typescript-boilerplate.git

Compiling Typescript source

$ npm run build

Running Server

$ npm run start

Tests

$ npm run test

Please, take a look into package.json to check other useful scripts such as Linters, Prettier, Releasing and testing with coverage

Todos

• Fix test with --coverage. For some reason the snapshots when using Jest's coverage are different than the default testing behavior.
• Get 100% of coverage in tests
• Include more Use Cases examples.
• Keep it compatible with Node LTS.

Licence

MIT License