[update] - Readme file

This commit is contained in:
Swapnil
2024-12-18 23:47:36 +05:30
parent e93682bb31
commit e55c54e05f

View File

@@ -1,5 +1,20 @@
# **TypeScript Backend Template**
This backend template follows the principles of CLEAN Architecture to ensure:
- **Separation of Concerns:** Layers are organized to separate business logic, application logic, and infrastructure concerns.
- **Scalability:** Modular and well-organized codebase makes it easy to extend functionality.
- **Testability:** Well-defined boundaries between layers simplify unit and integration testing.
- **Maintainability:** Consistent structure and adherence to SOLID principles reduce technical debt over time.
### **Structure Overview**
- **Core Domain:** Contains the business rules and logic.
- **Use Cases:** Implements application-specific rules and orchestrates the flow of data.
- **Infrastructure:** Deals with external systems (e.g., database, APIs).
- **Presentation:** Manages HTTP communication and routes.
Refer to the documentation for details on how to structure and organize your code.
---
## **Table of Contents**
@@ -70,7 +85,6 @@ Create a `.env` file in the root directory based on the structure of [`.env.exam
|---------------------|-------------------------------------------------------------|
| `npm start` | Starts the app in production mode using PM2. |
| `npm run dev` | Starts the app in development mode with `nodemon`. |
| `npm run test` | Starts the app in test mode with `nodemon`. |
| `npm run lint` | Runs ESLint to check for code quality issues. |
| `npm run lint:fix` | Fixes fixable issues detected by ESLint. |
| `npm run prettier` | Checks code formatting using Prettier. |