Skip to content

Commit 91d11b0

Browse files
authored
Merge branch 'main' into chore/update_dockerfile
2 parents 1c0a8fe + 6749a87 commit 91d11b0

1 file changed

Lines changed: 33 additions & 1 deletion

File tree

README.md

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11

2+
23
# Clean code Architecture pattern applied to Node.js REST API Example
34

45

@@ -10,6 +11,7 @@
1011

1112
> This project demonstrates how to apply Uncle Bob's Clean Architecture principles in a Node.js REST API. It is designed as an educational resource to help developers structure their projects for maximum testability, maintainability, and scalability. The codebase shows how to keep business logic independent from frameworks, databases, and delivery mechanisms.
1213
14+
1315
## Stack
1416

1517
- **Node.js** (Express.js) for the REST API
@@ -37,6 +39,36 @@
3739
- The product use case receives a `createProductDbHandler` as a parameter. In production, this is the real DB handler; in tests, it's a mock function.
3840
- Lower layers (domain, use cases) never import or reference Express, MongoDB, or any framework code.
3941

42+
=======
43+
44+
## Stack
45+
46+
- **Node.js** (Express.js) for the REST API
47+
- **MongoDB** (MongoClient) for persistence
48+
- **Jest** & **Supertest** for unit and integration testing
49+
- **ESLint** & **Prettier** for linting and formatting
50+
- **Docker** & **Docker Compose** for containerization
51+
- **GitHub Actions** for CI/CD
52+
53+
## Why Clean Architecture?
54+
55+
- **Separation of Concerns:** Each layer has a single responsibility and is independent from others.
56+
- **Dependency Rule:** Data and control flow from outer layers (e.g., routes/controllers) to inner layers (use cases, domain), never the reverse. Lower layers are unaware of upper layers.
57+
- **Testability:** Business logic can be tested in isolation by injecting dependencies (e.g., mock DB handlers) from above. No real database is needed for unit tests.
58+
- **Security & Flexibility:** Infrastructure (DB, frameworks) can be swapped without touching business logic.
59+
60+
> **✨ Ultimate Flexibility:**
61+
> This project demonstrates that your core business logic is never tied to any specific framework, ORM, or database. You can switch from Express to Fastify, MongoDB to PostgreSQL, or even move to a serverless environment—without rewriting your business rules. The architecture ensures your codebase adapts easily to new technologies, making future migrations and upgrades painless. This is true Clean Architecture in action: your app’s heart beats independently of any tool or vendor.
62+
63+
## How Testing Works
64+
65+
- **Unit tests** inject mocks for all dependencies (DB, loggers, etc.) into use cases and controllers. This means you can test all business logic without a real database or server.
66+
- **Integration tests** can use a real or in-memory database, but the architecture allows you to swap these easily.
67+
- **Example:**
68+
- The product use case receives a `createProductDbHandler` as a parameter. In production, this is the real DB handler; in tests, it's a mock function.
69+
- Lower layers (domain, use cases) never import or reference Express, MongoDB, or any framework code.
70+
71+
4072
## Project Structure
4173

4274
```
@@ -89,7 +121,7 @@ public/ # Static files and HTML views
89121
```bash
90122
yarn install
91123
```
92-
3. Copy `.env.example` to `.env` and set your environment variables. For production, set `NODE_ENV=production` (logging is disabled in production; file and console logs run only in development).
124+
3. Copy `.env.example` to `.env` and set your environment variables. For production, set `NODE_ENV=production`
93125
4. Start the server:
94126
```bash
95127
yarn dev

0 commit comments

Comments
 (0)