Merge pull request #16 from Sangam5756/Feat_API_documentation_Implemented

Feat Readme Update

Author: Sangam5756

Architecture.md

@@ -76,7 +76,7 @@ Also shows how the frontend communicates with backend routes and how backend com
 
 
 ## 🧠 Entity Relationship Diagram (ERD)
-![ER Diagram](./Design/ER_Diagram.png)
+![ER Diagram](./Design/database/ER_Diagram.png)
 
 
 
@@ -101,7 +101,7 @@ Also shows how the frontend communicates with backend routes and how backend com
             - findPostById
             - createPOst
             - updatePost
-            - DelelePost
+            - DeletePost
             - getAllPost
             -getPostById
             

feed.md Design/feed.mdfeed.md renamed to Design/feed.md

@@ -1,57 +1,3 @@
-# 1 — PlantUML code
-
-
-```plantuml
-@startuml
-' Title
-title Materialized Feed Architecture (BullMQ + Redis + MongoDB)
-
-actor "Client (Browser / Mobile)" as Client
-node "API Server\n(Node.js / Express)" as API
-database "MongoDB\nPrimary DB\n(Questions, Likes, Answers)" as Mongo
-database "MongoDB\nFeed Collection\n(denormalized)" as FeedDB
-folder "Redis\nBullMQ" as Redis
-node "Feed Worker\n(BullMQ Worker)" as Worker
-node "Backfill Job\n(Batch Script)" as Backfill
-cloud "Monitoring / Metrics\n(Prometheus / Grafana)" as Monitoring
-
-Client --> API : GET /feed/public
-API --> FeedDB : Query feed (fast indexed read)
-API --> Mongo : (writes) create Question / Like / Answer / Update
-API --> Redis : push job to queue (feed-updates)\n(e.g. like-added, answer-added)
-API --> Client : 200 OK (feed JSON)
-
-Redis --> Worker : job consumed
-Worker --> FeedDB : upsert / $inc (likes,dislikes,replies)
-Worker --> Mongo : optionally read question snapshot (on question-created/update)
-Worker --> Redis : ack (job completed)
-
-Backfill --> Mongo : scan questions, counts
-Backfill --> FeedDB : bulk upsert seed / reconcile
-
-Monitoring <.. API : metrics
-Monitoring <.. Worker : worker metrics
-Monitoring <.. Redis : queue depth
-
-' Notes
-note right of API
-  - Publish events (like-added, like-removed,\n    dislike-added, answer-added, question-created)
-  - API only pushes job, returns quickly
-end note
-
-note left of Worker
-  - Jobs processed concurrently
-  - Atomic updates with $inc
-  - Idempotency & retries via BullMQ
-end note
-
-@enduml
-```
-
----
-
-
-````markdown
 # Materialized Feed Service (BullMQ + Redis + MongoDB)
 
 ## Overview
@@ -80,8 +26,9 @@ Reads are fast (single query to `Feed`), and expensive aggregations are handled
     "likes": 0,
     "dislikes": 0,
     "replies": 0
-  }
-````
+  }```
+
+
 
 * **Backfill script**: Recompute and populate `Feed` documents from primary DB to recover drift.
 
@@ -163,9 +110,8 @@ Prereqs: Node.js, MongoDB, Redis
 
 MIT
 
-```
 
----
+
 
 # 3 — Cause-of-change examples in STAR format
 
@@ -210,4 +156,4 @@ Below are short STAR entries for the common events that cause the feed to change
   - c) the worker code with idempotency (event dedupe with Redis or Mongo dedupe table)?
 
 Tell me which of (a–c) to deliver next and I’ll produce the code files ready to paste into your project.
-```
+

README.md

@@ -4,6 +4,9 @@ DevFlow is a full-stack, production-grade **developer Q\&A platform** inspired b
 
  👨‍💻 Built with a scalable architecture in mind, DevFlow empowers users to ask programming questions, post answers, and engage in in-depth threaded conversations.
 
+
+* 🔗 **Live Project**: https://devflowbackend.sangammundhe.site/api-docs
+
 ---
 
 ## 🚀 Why DevFlow?
@@ -191,8 +194,8 @@ MIT License. Feel free to use, share, or build on top of this!
 
 ## 🌍 Links
 
-* 🔗 **Live Project**: *Coming Soon*
-* 📦 **Repo**: [github.com/your-username/devflow](https://github.com/Sangam5756/devflow)
+* 🔗 **Live Project**: https://devflowbackend.sangammundhe.site/api-docs
+* 📦 **Repo**: [github.com/Sangam5756/devflow](https://github.com/Sangam5756/devflow)
 * 🧠 **Follow**: [X @sangammundhe](https://x.com/sangammundhe)
   Tag: `#BuildInPublic #DevFlow`