# vaishnavi-a-das/collaborative-study-platform architecture

> Architecture diagram of the GitHub repository vaishnavi-a-das/collaborative-study-platform, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-07-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vaishnavi-a-das/collaborative-study-platform
- Repository: https://github.com/vaishnavi-a-das/collaborative-study-platform

## Overview

1. This repo is a split-client/server collaborative study platform: a React single-page app in `frontend/` talks to an Express/Node backend in `backend/`, with MongoDB/Mongoose as the persistent system of record. Real-time collaboration is layered on top with Socket.IO, while audio/video sessions use WebRTC peer-to-peer connections.

2. The frontend is organized around three main pages: `Home` for landing, `Auth` for login/registration, and `Dashboard` for the live workspace. `App.js` is the top-level composition point, and `services/socket.js` is the client’s dedicated Socket.IO connection layer.

3. The collaborative workspace is decomposed into focused UI modules: `ChatArea`, `Whiteboard`, `MembersList`, and `Sidebar`, with modal components for creating rooms, joining rooms, inviting members, viewing invitations, and handling pending requests. This indicates the dashboard is the main shell that orchestrates room state and multiple collaboration tools side by side.

4. The backend exposes REST routes under `routes/auth.js`, `routes/rooms.js`, and `routes/users.js`. These are protected by `middleware/auth.js`, so JWT-based authentication gates access to room and user operations.

5. MongoDB data is modeled explicitly through Mongoose models: `User`, `Room`, `Message`, and `Invitations`. That suggests persistence is split by concern: identity/accounts, room membership and metadata, chat/message history, and invitation/request workflow.

6. The real-time data plane is Socket.IO. It is used for instant chat delivery, online/offline member presence, room membership updates, whiteboard synchronization, and WebRTC signaling. The frontend socket client and the backend Socket.IO server are the key boundary for live collaboration events.

7. WebRTC is used only for media transport, not for app state. The signaling flow goes through Socket.IO, then peers connect directly using STUN-backed peer negotiation. That means audio/video and screen-sharing traffic bypasses the app server after setup, reducing backend media load.

8. There is a backend service at `services/gemini.js`, which implies an AI/chatbot capability inside the study room experience. Architecturally, this is a supporting service invoked from the server side rather than a separate product boundary.

9. The deployment boundary is standard for a modern MERN app: frontend on Vercel, backend on Render, database on MongoDB Atlas. The frontend is configured to point to backend API and socket URLs via environment variables, so the UI can be deployed independently from the API.

10. If you are drawing the architecture, the most important relationships are: React UI ↔ REST API for authentication and persistent room/user data; React UI ↔ Socket.IO for live collaboration; Socket.IO ↔ backend for signaling and broadcast; backend ↔ MongoDB for persistence; and WebRTC ↔ browser peers for audio/video once signaling completes.

Main entry points: [`frontend/src/pages/Dashboard.jsx`](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/pages/Dashboard.jsx) (Dashboard), [`backend/server.js`](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/server.js) (Server), [`frontend/src/App.js`](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/App.js) (App), [`backend/middleware/auth.js`](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/middleware/auth.js) (Auth Guard)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Frontend"]
  node_frontend_app["App<br/>React root<br/>[App.js]"]
  node_frontend_home["Home<br/>page<br/>[Home.jsx]"]
  node_frontend_auth["Auth<br/>page<br/>[Auth.jsx]"]
  node_frontend_dashboard["Dashboard<br/>workspace<br/>[Dashboard.jsx]"]
  node_frontend_chat["ChatArea<br/>collab ui<br/>[ChatArea.jsx]"]
  node_frontend_whiteboard["Whiteboard<br/>collab ui<br/>[Whiteboard.jsx]"]
  node_frontend_members["MembersList<br/>collab ui<br/>[MembersList.jsx]"]
  node_frontend_sidebar["Sidebar<br/>workspace nav<br/>[Sidebar.jsx]"]
  node_frontend_modals["Room Modals<br/>dialogs"]
  node_frontend_socket["Socket Client<br/>realtime client<br/>[socket.js]"]
end

subgraph group_backend["Backend"]
  node_backend_server["Server<br/>Express app<br/>[server.js]"]
  node_backend_auth_route["Auth Routes<br/>REST route<br/>[auth.js]"]
  node_backend_room_route["Room Routes<br/>REST route<br/>[rooms.js]"]
  node_backend_user_route["User Routes<br/>REST route<br/>[users.js]"]
  node_backend_auth_mw{{"Auth Guard<br/>middleware<br/>[auth.js]"}}
  node_backend_models[("Mongoose Models<br/>data model")]
  node_backend_gemini["Gemini Service<br/>ai service<br/>[gemini.js]"]
  node_db_mongo[("MongoDB<br/>database")]
end

subgraph group_realtime["Realtime & Media"]
  node_realtime_socket(("Socket.IO<br/>event bus"))
  node_realtime_webrtc(("WebRTC<br/>peer media"))
end

node_frontend_app -->|"renders"| node_frontend_home
node_frontend_app -->|"routes"| node_frontend_auth
node_frontend_app -->|"routes"| node_frontend_dashboard
node_frontend_dashboard -->|"contains"| node_frontend_chat
node_frontend_dashboard -->|"contains"| node_frontend_whiteboard
node_frontend_dashboard -->|"contains"| node_frontend_members
node_frontend_dashboard -->|"contains"| node_frontend_sidebar
node_frontend_dashboard -->|"opens"| node_frontend_modals
node_frontend_socket -->|"connects"| node_realtime_socket
node_frontend_app -->|"uses"| node_frontend_socket
node_backend_server -->|"serves"| node_backend_auth_route
node_backend_server -->|"serves"| node_backend_room_route
node_backend_server -->|"serves"| node_backend_user_route
node_backend_auth_route -->|"protects"| node_backend_auth_mw
node_backend_room_route -->|"protects"| node_backend_auth_mw
node_backend_user_route -->|"protects"| node_backend_auth_mw
node_backend_server -->|"hosts"| node_realtime_socket
node_realtime_socket -->|"signals"| node_realtime_webrtc
node_backend_server -->|"uses"| node_backend_models
node_backend_models -->|"persists to"| node_db_mongo
node_backend_server -->|"invokes"| node_backend_gemini
node_frontend_dashboard -->|"receives"| node_realtime_socket
node_frontend_dashboard -->|"establishes"| node_realtime_webrtc
node_frontend_dashboard -->|"api calls"| node_backend_server

click node_frontend_app "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/App.js"
click node_frontend_home "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/pages/Home.jsx"
click node_frontend_auth "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/pages/Auth.jsx"
click node_frontend_dashboard "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/pages/Dashboard.jsx"
click node_frontend_chat "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/components/ChatArea.jsx"
click node_frontend_whiteboard "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/components/Whiteboard.jsx"
click node_frontend_members "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/components/MembersList.jsx"
click node_frontend_sidebar "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/components/Sidebar.jsx"
click node_frontend_socket "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/services/socket.js"
click node_backend_server "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/server.js"
click node_backend_auth_route "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/routes/auth.js"
click node_backend_room_route "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/routes/rooms.js"
click node_backend_user_route "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/routes/users.js"
click node_backend_auth_mw "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/middleware/auth.js"
click node_backend_gemini "https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/services/gemini.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_frontend_app,node_frontend_home,node_frontend_auth,node_frontend_dashboard,node_frontend_chat,node_frontend_whiteboard,node_frontend_members,node_frontend_sidebar,node_frontend_modals,node_frontend_socket toneBlue
class node_backend_server,node_backend_auth_route,node_backend_room_route,node_backend_user_route,node_backend_auth_mw,node_backend_models,node_backend_gemini,node_db_mongo toneAmber
class node_realtime_socket,node_realtime_webrtc toneMint
```

## Components

### Frontend

React single-page app and workspace UI

- [App](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/App.js): React root · Top-level UI composition and routing · `frontend/src/App.js`
- [Home](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/pages/Home.jsx): page · Landing page · `frontend/src/pages/Home.jsx`
- [Auth](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/pages/Auth.jsx): page · Login and registration screen · `frontend/src/pages/Auth.jsx`
- [Dashboard](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/pages/Dashboard.jsx): workspace · Main collaborative room shell · `frontend/src/pages/Dashboard.jsx`
- [ChatArea](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/components/ChatArea.jsx): collab ui · Room chat panel · `frontend/src/components/ChatArea.jsx`
- [Whiteboard](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/components/Whiteboard.jsx): collab ui · Shared drawing and annotation surface · `frontend/src/components/Whiteboard.jsx`
- [MembersList](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/components/MembersList.jsx): collab ui · Presence and room participant list · `frontend/src/components/MembersList.jsx`
- [Sidebar](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/components/Sidebar.jsx): workspace nav · Room navigation and actions · `frontend/src/components/Sidebar.jsx`
- **Room Modals**: dialogs · Create, join, invite, invitation, and request dialogs
- [Socket Client](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/frontend/src/services/socket.js): realtime client · Browser Socket.IO connection layer · `frontend/src/services/socket.js`

### Backend

Express API, persistence, and live collaboration server

- [Server](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/server.js): Express app · HTTP API and realtime server entrypoint · `backend/server.js`
- [Auth Routes](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/routes/auth.js): REST route · Authentication endpoints · `backend/routes/auth.js`
- [Room Routes](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/routes/rooms.js): REST route · Room lifecycle and collaboration endpoints · `backend/routes/rooms.js`
- [User Routes](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/routes/users.js): REST route · User-related endpoints · `backend/routes/users.js`
- [Auth Guard](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/middleware/auth.js): middleware · JWT protection for secured routes · `backend/middleware/auth.js`
- **Mongoose Models**: data model · User, Room, Message, and Invitation schemas
- [Gemini Service](https://github.com/vaishnavi-a-das/collaborative-study-platform/blob/main/backend/services/gemini.js): ai service · Server-side assistant or chat support integration · `backend/services/gemini.js`
- **MongoDB**: database · Persistent system of record

### Realtime & Media

Live collaboration and peer media transport

- **Socket.IO**: event bus · Live collaboration transport and signaling
- **WebRTC**: peer media · Direct browser-to-browser audio/video and screen sharing

## Connections

- App → Home: renders · Top-level composition includes landing view
- App → Auth: routes · Top-level auth view
- App → Dashboard: routes · Top-level workspace view
- Dashboard → ChatArea: contains · Dashboard hosts chat
- Dashboard → Whiteboard: contains · Dashboard hosts whiteboard
- Dashboard → MembersList: contains · Dashboard shows members
- Dashboard → Sidebar: contains · Dashboard shell controls room actions
- Dashboard → Room Modals: opens · Workspace uses dialogs for room and invitation workflows
- Socket Client → Socket.IO: connects · Client realtime connection
- App → Socket Client: uses · Application-level socket access
- Server → Auth Routes: serves · Authentication API
- Server → Room Routes: serves · Room API
- Server → User Routes: serves · User API
- Auth Routes → Auth Guard: protects · JWT gating on secured auth flows
- Room Routes → Auth Guard: protects · Room operations require auth
- User Routes → Auth Guard: protects · User operations require auth
- Server → Socket.IO: hosts · Socket.IO server boundary
- Socket.IO → WebRTC: signals · Negotiates peer media connections
- Server → Mongoose Models: uses · API and realtime flows persist through models
- Mongoose Models → MongoDB: persists to · Mongoose-backed storage
- Server → Gemini Service: invokes · Server-side AI support service
- Dashboard → Socket.IO: receives · Chat, presence, and whiteboard updates
- Dashboard → WebRTC: establishes · Peer media sessions after signaling
- Dashboard → Server: api calls · Persistent auth and room operations
