@@ -58,11 +58,13 @@ DevCamper is a RESTful API that provides a platform for bootcamps, courses, revi
5858## Installation
5959
60601 . Clone the repository
61+
6162```
6263git clone https://github.com/SymonMuchemi/DevCamper-API.git
6364```
6465
65662 . Install dependencies
67+
6668```
6769npm install
6870```
@@ -102,11 +104,11 @@ npm start
102104
1031056 . Access the application on ` http://localhost:3001/ `
104106
105-
106107## API Documentation
107108
108109- Local documentation: [ http://localhost:3001/ ] ( http://localhost:3001/ )
109110- Live documentation: [ link] ( https://51.21.253.85/ )
111+ - Postman Published Documentation: [ link] [ https://documenter.getpostman.com/view/33408943/2sAYkBsghW ]
110112
111113## Infrastructure Design
112114
@@ -123,34 +125,39 @@ npm start
123125### Components
124126
125127- ** Web Server (Public Subnet)**
126- - Handles HTTP requests from users.
127- - Interacts with the Redis cache for reading cached data and writing cache/stream data.
128+
129+ - Handles HTTP requests from users.
130+ - Interacts with the Redis cache for reading cached data and writing cache/stream data.
128131
129132- ** Redis Cache (Private Subnet)**
130- - Acts as a caching layer to store frequently accessed data.
131- - Also used for writing to the mail stream.
133+
134+ - Acts as a caching layer to store frequently accessed data.
135+ - Also used for writing to the mail stream.
132136
133137- ** Mail Stream (Private Subnet)**
134- - A stream of email messages that need to be processed.
135- - Written to by the web server and read by the mail worker.
138+
139+ - A stream of email messages that need to be processed.
140+ - Written to by the web server and read by the mail worker.
136141
137142- ** Mail Worker (Private Subnet)**
138- - Reads from the mail stream.
139- - Processes email messages and sends them to users.
143+ - Reads from the mail stream.
144+ - Processes email messages and sends them to users.
140145
141146### Data Flow
142147
143148- ** User Interaction**
144- - A user sends an HTTP request to the web server.
149+
150+ - A user sends an HTTP request to the web server.
145151
146152- ** Web Server Operations**
147- - The web server processes the request.
148- - It may read cached data from Redis.
149- - It writes data to the Redis cache and the mail stream.
153+
154+ - The web server processes the request.
155+ - It may read cached data from Redis.
156+ - It writes data to the Redis cache and the mail stream.
150157
151158- ** Mail Stream Processing**
152- - The mail worker reads from the mail stream.
153- - Processes the email messages and sends them to the user.
159+ - The mail worker reads from the mail stream.
160+ - Processes the email messages and sends them to the user.
154161
155162### Network Security
156163
@@ -160,4 +167,3 @@ npm start
160167## Author
161168
162169- [ Simon Muchemi] ( https:www.github.com/SymonMuchemi )
163-
0 commit comments