Node API Clean Architecture - DEPRECATED - Use https://nestjs.com/

-> You can use NestJs, which covers the studies done in this repository as module integration. Please use https://nestjs.com/

APIs focused on separation of concerns and scalability with Clean Architecture

Multilayer folder structure: Code organization inspired by DDD and Clean Architecture focused on codebase scalability.
Scalable and easy to use web server: Use Express for requests routing and middlewares. There are some essential middlewares for web APIs already setup, like body-parser, compression, CORS and method-override.
Database integration: Sequelize, an ORM for SQL databases, is already integrated, you just have to set the authentication configurations.
Prepared for testing: The test suite uses Mocha/Chai and is prepared to run unit, integration and functional tests right from the beginning. There are helpers to make it easy to make requests to the web app during the tests and for cleaning the database after each test. A FactoryGirl adapter for Sequelize is setup to make your tests DRY as well, and the tests generate code coverage measurement with Istanbul. You should read about the Chai plugins that are setup by default too.
Dependency injection: With Awilix, a practical dependency injection library, the code will not be coupled and it'll still be easy to resolve automatically the dependencies on the runtime and mock them during the tests. It's even possible inject dependencies on your controllers with the Awilix Express adapter. Click here if you want to read more about how to use dependency injection with this boilerplate.
Logging: The Log4js logger is highly pluggable, being able to append the messages to a file during the development and send them to a logging service when on production. Even the requests (through morgan) and queries will be logged.
Linter: It's also setup with ESLint to make it easy to ensure a code styling and find code smells.
CLI integration: Both the application and Sequelize have command-line tools to make it easy to work with them. Check the Scripts section to know more about this feature.

Scripts

This boilerplate comes with a collection of npm scripts to make your life easier, you'll run them with npm run <script name> or yarn run <script name>:

dev: Run the application in development mode
start Run the application in production mode (prefer not to do that in development)
test: Run the test suite
test:http: Run only the http tests
test:unit: Run only the unit tests of all layers
test:data:unit: Run only the unit tests of layer data
test:domain:unit: Run only the unit tests of layer domain
coverage: Run only the unit tests and generate code coverage for them, the output will be on coverage folder
lint: Lint the codebase
sequelize: Alias to the Sequelize CLI
console: Open the built-in console, you can access the DI container through the container variable once it's open, the console is promise-friendly.

Layers

Presentation: Layer to manage initial data access through Routes and Controllers
Domain: Layer to manage business rules using UseCase propagating events through broadcasts (EventEmitter)
Data: Layer for integrade access data using Repository and DataSource in local database or cloud

See more clean architecture reference

Quick start

Notice that the project comes with a small application for user management already, you can delete it with a npm script after you understand how the project works but please do the quick start first! 😊

Clone the repository with git clone --depth=1 https://github.com/charleston10/api-nodejs-clean-architecture
Setup the database on config/database.js (there's an example file there to be used with PostgreSQL 😉 )
Install the dependencies with npm (click here if you don't have Npm installed)
Create the development and test databases you have setup on config/database.js
Run the database migrations with npm run sequelize db:migrate
Add some seed data to the development database with npm run sequelize db:seed:all
Run the application in development mode with npm run dev
Access http://localhost:3000/api/users and you're ready to go!
Access http://localhost:3000/api/docs for you see docs with swagger

Dependencies

Special thanks