How ekas-7/chat-app works
Project type and purpose
• This is a full-stack, real-time chat application.
• Purpose: allow multiple users to exchange messages, share files, manage chat rooms, track presence and read receipts.
File structure
• Top level: .env.example, docker-compose.yml, start.sh, three main folders: frontend, server, socket.
• frontend: React/Vite app (components, context, service wrappers).
• server: Express.js API (models, controllers, routes, MongoDB connection, file uploads).
• socket: Socket.IO WebSocket server for real-time events.
• Infrastructure files: Dockerfiles in each folder, Compose orchestration.
Key insights from the README
• Frontend uses React 18, TailwindCSS, Material UI, Socket.IO client, Google OAuth.
• Backend: Express, Mongoose, Multer, CORS.
• Socket server: Socket.IO, user presence tracking, message delivery.
• Orchestrated via Docker Compose, exposes ports: 5173 (UI), 3000 (API), 8080 (WS), 27017 (MongoDB).
Main components
a. Frontend UI layer
• React app container
• Context provider for auth and messaging state
• Service module for HTTP calls
• Socket.IO client for real-time events
b. Backend API
• Express.js server
• Controllers (convo, users, messages, images)
• Mongoose models (User, Message, Convo, File)
• Multer-based upload utility
c. Socket Server
• Socket.IO server entry point
• Event handlers for connection, join room, message, presence
d. Database
• MongoDB instance (collections: users, messages, convos, files)
e. External services
• Google OAuth provider
• (Optional) Cloud storage if file uploads go beyond local FS
f. DevOps / Orchestration
• Docker Compose network connecting all containers
• Environment variables via .env
Relationships and interactions
• Frontend → HTTP REST → Backend API (auth, CRUD chat rooms, file upload).
• Frontend ↔ WebSocket → Socket Server (real-time message broadcast, presence updates).
• Backend API ↔ MongoDB (read/write data models).
• Frontend uses Google OAuth (redirect→token→API/Socket auth).
Architectural patterns and principles
• Separation of concerns: UI, API, real-time layer, data persistence.
• MVC-style in the API (models/controllers/routes).
• Pub/Sub pattern in Socket.IO for event distribution.
• Context API for global state management in React.
• Containerization for environment parity (Docker).
Technologies and frameworks to label
• React 18, Vite, TailwindCSS, Material UI, Socket.IO client.
• Node.js, Express.js, Mongoose, Multer, CORS.
• Socket.IO server.
• MongoDB.
• Google OAuth.