📝 [Docs]: Add Missing “Project Setup Flow Diagram” in README

[kalyani-jadhav-project]

The current README is very detailed and well-structured, but it is missing a visual or step-by-step flow representation of how the system works end-to-end.

New contributors often struggle to quickly understand how the frontend, backend, and database interact during key actions like task creation or routine scheduling.

Suggested Improvement

Add a new section in README.md:

🔄 System Flow Overview

Include a simple flow explanation like:

1. User Action (Frontend)
   User creates a task or drags it into a routine grid
   React UI captures input using components in frontend/src/components

2. API Request
   Axios sends request to backend:
   /api/tasks
   /api/routines

3. Backend Processing
   Express route handles request
   Controller processes logic (taskController.js, routineController.js)
   Mongoose schema validates and stores data

4. Database Layer
   MongoDB stores tasks, routines, and user data
   Data is returned to backend after update

5. Response to Frontend
   Backend returns JSON response
   React updates UI state via Context API / hooks

💡 Why this is needed
Helps new contributors understand full-stack flow faster
Improves onboarding experience for GSSoC participants
Bridges gap between backend structure and frontend components
Reduces confusion when debugging API calls

🏷 Suggested Labels
documentation
enhancement
good first issue

🚀 Impact
Better contributor onboarding
Easier debugging and development understanding
Improved README clarity for MERN architecture

[kalyani-jadhav-project]

Hi @aryandas2911, I’d like to work on this issue. Please assign it to me. I confirm I don’t have any other active assigned issues

[kalyani-jadhav-project]

/assign

[github-actions]

Hi @kalyani-jadhav-project, please wait 6h before claiming this issue again (cooldown active).

[GeethaBurigalla]

/assign

[github-actions]

Hi @GeethaBurigalla, please wait 6h before claiming this issue again (cooldown active).

[khalidsaifullah-ks]

Hi! I am a GSSoC '26 contributor. I would love to work on this issue. Could you please assign it to me? Thank you!

[karrisanthoshigayatri]

Hi @aryandas2911,

I'd like to work on this documentation issue under GSSoC'26.

I understand that the README currently explains the project well but lacks a visual overview of the end-to-end request flow. My approach will be to add a dedicated "System Flow Overview" section with a clear flow diagram (using Mermaid for GitHub rendering) along with a concise step-by-step explanation of how the frontend, backend, and database interact during common operations such as task creation and routine scheduling.

I'll ensure the documentation is easy for new contributors to follow and remains consistent with the current project architecture.

Could you please assign this issue to me? Thank you!

[babligariya04-maker]

Hi @aryandas2911,

I'm a GSSoC'26 contributor and would like to work on this documentation issue. I believe adding a clear system flow overview will make it much easier for new contributors to understand how the frontend, backend, and database interact.

If assigned, I'll ensure the README remains clear, well-structured, and easy to follow.

Could you please assign this issue to me?

Thank you!