Skip to content

Commit cd09a0c

Browse files
authored
Merge pull request #68 from SOURAV-ROY/ROY
docs: Add System Design documentation and update README
2 parents 8c92e98 + 8ad88ba commit cd09a0c

2 files changed

Lines changed: 815 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ Backend API for the DevCamper application to manage bootcamps, courses, reviews,
66

77
The documentation has been split into several files for better organization:
88

9+
- **[System Design](docs/SYSTEM_DESIGN.md)**: Comprehensive system architecture, design patterns, and technical overview of the project.
910
- **[Setup and Configuration](docs/SETUP_AND_CONFIGURATION.md)**: Instructions on how to install, configure, and run the project.
1011
- **[API Reference](docs/API_REFERENCE.md)**: Detailed documentation of all API endpoints, including request/response examples.
1112
- **[Project Structure](docs/PROJECT_STRUCTURE.md)**: Explanation of the codebase organization and key directories.
13+
- **[Project Flow](docs/PROJECT_FLOW.md)**: Request lifecycle and data flow diagrams.
1214

1315
## Key Features
1416

0 commit comments

Comments
 (0)