This monorepo implements Clean Architecture in Node (Javascript).
Rule of Clean Architecture by Uncle Bob
- Independent of Frameworks. The architecture does not depend on the existence of some library of feature laden software. This allows us to use such frameworks as tools, rather than having to cram our system into their limited constraints.
- Testable. The business rules can be tested without the UI, Database, Web Server, or any other external element.
- Independent of Database. We can swap out Mongodb, for Rocksdb, Dynamodb, CouchDB, or something else. Our business rules are not bound to the database.
More here
This repo has 4 layers
- Entities (entities/domain)
- Database (Repositories)
- Application (Use cases)
- Delivery (controller/delivery)
The original explanation which is written in golang about this repos structure can be read from this medium's post : https://medium.com/@imantumorang/golang-clean-archithecture-efd6d7c43047.
It may be different already, but the concept is still the same in application level
run npm i to install all dependencies, then create a .env file in the root of the project and add the following environment in the .env.example file
- Run the codebase in development -
npm run dev - Run the codebase in production -
npm start
- winston - logging
- pkg - for third party package management
- dotenv - for environment variable management