How gayatriagarwal19/clover works
Project Type & Purpose
• Full-stack real-time messaging & conferencing web app.
• Frontend: React SPA (Vite) with Redux, socket.io, WebRTC client libs.
• Backend: Node.js/Express + socket.io + mediasoup SFU.
• Persistence: MongoDB (Mongoose).
• External services: SMTP (sendMail), STUN/TURN servers.
Main Components
a. Client (Browser)
– Static assets served via Vite dev server (dev) or CDN/Vercel (prod).
– React SPA modules: pages (Login, Home, ForgotPassword), features (Conversation, Meeting, Panel…).
– Redux store: actions, reducers, middleware (socket.io-promise).
– Media capture libs (getUserAudio/Video/Screen).
– socket.io client for real-time messaging/signaling.
b. API Layer (Backend Express)
– HTTP routes under /auth, /rooms, /messages, /users, /files, /rtc, /meeting.
– socket.io namespace for events (init, more-messages, typing, status).
– Mediasoup controller (in src/mediasoup) for WebRTC SFU orchestration.
c. Database
– MongoDB via Mongoose.
– Collections: User, Room, Message, Meeting, File, Image, Email, AuthCode.
d. External Services
– SMTP server (sendMail utility) for verification codes.
– STUN/TURN (configured in backend/config.js).
e. Launcher/Scripts
– scripts/launcher.js orchestrates startup (both frontend and backend in dev).
– launcher/* (optional bundling or Docker orchestration).
Relationships & Data Flows
– HTTP Request/Response:
• User actions (login/register, CRUD rooms/files) → Express REST endpoints → Mongoose → MongoDB → JSON response → React UI.
– WebSocket/socket.io:
• Chat messages, typing indicators, room events broadcast in real time.
– WebRTC Signaling (via HTTP+socket.io) → mediasoup SFU → Peer RTP streams.
– Media Streams:
• Clients send audio/video to SFU → SFU redistributes streams to participants.
– Email Service:
• Password reset/verification flows invoke sendMail utility → external SMTP.
Architectural Patterns & Design Principles
– Separation of Concerns:
• Frontend (presentation + client business logic) vs. Backend (API + real-time + media server).
– Modular Routing & Event Handlers:
• Each feature (auth, rtc, meeting, files) lives in its own express route file or socket handler.
– CQRS-style split:
• REST for CRUD, WebSocket for events.
– SFU (Selective Forwarding Unit) pattern via mediasoup for group calls.
a. Partition your canvas into three horizontal tiers (or vertical columns):
1. Client Tier (Browser)
2. Server Tier (Express + mediasoup)
3. Data & External Services Tier (MongoDB, SMTP, STUN/TURN)
– In Client Tier: “React SPA”, “Redux Store”, “socket.io client”, “getUserMedia libs”.
– In Server Tier: “Express HTTP Server”, “socket.io Server”, “Mediasoup Workers”.
– In Data Tier: “MongoDB Cluster”, “SMTP Service”, “STUN/TURN Servers”.
– HTTP calls → Express → MongoDB → HTTP response.
– WebSocket ↔ socket.io ↔ Express events.
– Signaling over socket.io/HTTP → Mediasoup → RTP streams ↔ Clients.
– sendMail utility → SMTP.
d. Major endpoints:
– /api/auth/, /api/rooms/, /api/meeting/**, /rtc/create, /rtc/join, etc.
Final Checklist
[ ] Clear, descriptive labels for components & modules
[ ] Grouped containers for major subsystems
[ ] Annotations of key technologies (React, Redux, Express, socket.io, mediasoup, MongoDB)