How visris-19/baatify works
Project type and purpose
• Type: Full-stack real-time chat application (WhatsApp-like clone) with stories.
• Purpose: Enable authenticated users to exchange messages in one-on-one chats, post 24-hour stories, and view user profiles with real-time updates via WebSockets.
File structure
• Top-level split into two directories: Backend/ and Frontend/.
• Backend/ follows an MVC-style layout:
• models/ (MongoDB schemas)
• controllers/ (Express request handlers)
• routes/ (Express routers mapping URIs to controllers)
• middleware/ (authentication, error handling, file upload)
• index.js (entry point that wires Express and Socket.IO)
• Frontend/ is a Vite-powered React SPA:
• src/components/ (feature-specific & shared UI components)
• src/pages/ (route targets)
• src/context/AuthContext.jsx (React Context for auth state)
• src/services/socket.js & Axios calls (WebSocket & REST clients)
• index.html + main.jsx (bootstraps the React app)
README
• Confirms tech stack: Node.js, Express, MongoDB, Socket.IO, JWT; React, React Router, Tailwind, Axios.
• Describes main features (auth, chats, messages, stories).
• Lists API endpoints and Socket events.
Diagramming the architecture
a. Main components
• Client (Browser/React SPA)
• API Layer (Express.js server)
• WebSocket Layer (Socket.IO server)
• Database (MongoDB)
• External Services (e.g., optional object storage for story uploads, SMTP for email)
b. Relationships & Interactions
• React UI ←→ REST API (Axios over HTTP) for CRUD operations (auth, chats, messages, stories).
• React UI ←→ Socket.IO (WebSocket) for real-time events (new messages, online status, stories).
• Express controllers ←→ MongoDB via Mongoose models.
• Middleware enforces JWT authentication on protected REST endpoints and WebSocket handshakes.
c. Architectural patterns & principles
• Backend: MVC (Models → Controllers → Routes), layered separation (middleware, controllers, data).
• Frontend: Component-based architecture, Context API for global state (auth), PrivateRoute for protected views.
• Real-time: Pub/Sub pattern via Socket.IO.
• Security: JWT for stateless authentication, middleware for request validation.
d. Key technologies
• Node.js & Express.js, Mongoose/MongoDB, Socket.IO, JWT
• React, React Router, Tailwind CSS, Axios, Vite
Detailed checklist
• UI Layer: show key pages (Login/Register, Chat window, Stories, Profile) and context provider.
• Service Layer: illustrate AuthController, ChatController, MessageController, StoryController.
• Data Layer: MongoDB collections (Users, Chats, Messages, Stories).
• WebSocket Hub: single Socket.IO server instance hooked into the Express app.
• Middleware: JWT auth and error handler between routes and controllers.
• External boundaries: user’s browser, database server, (optional) cloud file storage.