https://github.com/iam-abin/clean-architecture-nodejs

shopping api using clean architecture
https://github.com/iam-abin/clean-architecture-nodejs

clean-architecture expressjs mongodb nodejs

Last synced: about 4 hours ago
JSON representation

shopping api using clean architecture

• Host: GitHub
• URL: https://github.com/iam-abin/clean-architecture-nodejs
• Owner: iam-abin
• Created: 2023-10-20T07:30:02.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-06-06T22:23:43.000Z (5 months ago)
• Last Synced: 2024-06-06T23:33:58.155Z (5 months ago)
• Topics: clean-architecture, expressjs, mongodb, nodejs
• Language: JavaScript
• Homepage:
• Size: 35.2 KB
• Stars: 7
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# What is Clean Architecture?

- The fundamentals of clean architecture is separation of concerns, in other words dividing our application into layers so that every layer is independent of the other.

- It emphasizes the independence of your application’s core business logic from external concerns like the database, the framework, or the user interface. 

- This separation makes your codebase more maintainable, testable, and adaptable to changes.

### The benefits are as follows.

- Independence from any underlying framework.

- Freedom to plug and play with any database.

- Improve testability of code.

- Helps in maintaining larger code base easily.

- Modularity.

- Reduce development time and cost.

***Code Dependency Rule:***

 - Code Dependencies can only move from the outer levels inward. Code on the inner layers can have no knowledge of functions on the outer layers. 

 

 - The variables, functions, and classes in the outer layers cannot be mentioned in the more inward levels.

***Dependency injections:***

Dependency injection in Clean Architecture is a technique that allows you to provide the dependencies a component needs from the outside, promoting the separation of concerns and making it easier to test different implementations of those dependencies.

### Four Layers of Clean Architecture

1. Entity: is the inner most layer. It is like the heart of your application; it's where you define what your data looks like(structure of data) and how it behaves.

2. Use case: is a layer that will handle a specific business logic, for example getUserById or updateUser and will have all required validations and manipulation.

3. Controller: will handle the user requests and will make responses, but in order to get the responses we will call the relevant use cases, every controller will be connected to the express router.

4. Frameworks: are the outermost layer. responsible for handling external interfaces and communication, such as web interfaces, databases, and external services. 

 In a Node.js application, this typically includes Express.js for web APIs, databases like PostgreSQL or MongoDB, and any external libraries or services. This layer should contain all the code that interacts with the outside world, and it's the most concrete layer.