# vinayak409/whatsapp-clone-mern-stack architecture

> Architecture diagram of the GitHub repository vinayak409/whatsapp-clone-mern-stack, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vinayak409/whatsapp-clone-mern-stack
- Repository: https://github.com/vinayak409/whatsapp-clone-mern-stack

## Overview

##### Project type and purpose
- This is a real-time chat application (“WhatsApp clone”) built with the MERN stack plus a dedicated Socket.io service.
- It consists of three distinct services:
a. Frontend (React + Material-UI SPA)
b. Backend API (Node.js + Express + MongoDB, following an MVC-style controllers/models structure)
c. Socket service (Node.js + Socket.io for real-time messaging, typing indicators, online/offline status)
- Docker Compose glues them together along with a MongoDB container.

##### File structure
- Top level:
- client/ → React app (public/, src/ with components, context, service/api.js)
- server/ → Express API (controllers/, model/, routes/, database connection, Docker Compose file)
- socket/ → standalone Socket.io server (index.js)
- server/docker-compose.yml defines four services: server, client, socket, and MongoDB.
- server follows MVC: model files in server/model, controllers in server/controller, routes in server/routes.
- client uses React Context (AccountProvider) to hold user state and service/api.js for REST calls.

##### Key insights from README
- Real-time chat powered by Socket.io.
- REST endpoints handle user auth, search, conversations, messages, image upload.
- MongoDB provides persistence for users, conversations, messages.
- Docker or npm scripts can bring up the full stack.

a. Main components
1. React Frontend
2. Express REST API
3. Socket.io Server
4. MongoDB Database
5. (Optional) Image storage (local disk or cloud via server/utils/upload.js)
6. Docker Compose (orchestration)

b. Relationships & data flows
- Frontend ←HTTP/HTTPS→ Express API
- Authentication, user search, conversation history, image uploads
- Frontend ↔WebSocket (Socket.io)↔ Socket Server
- Real-time message delivery, typing indicators, presence updates
- Express API ↔MongoDB
- CRUD operations for User, Conversation, Message models
- Socket Server ↔MongoDB (or via Express)
- Could save messages directly or emit to API for persistence

c. Architectural patterns & design principles
- Microservice-style separation: distinct API and real-time services
- MVC in the backend: controllers/models/routes
- Single-page application with React Context for global state
- Docker Compose for service orchestration and environment parity

d. Technologies & frameworks
- Frontend: React.js, Material-UI, socket.io-client
- Backend API: Node.js, Express.js, Mongoose (MongoDB ODM), Multer (for uploads)
- Real-time: Socket.io server
- Persistence: MongoDB (Dockerized)
- Orchestration: Docker, Docker Compose

##### Detail
- Every container/service in Docker Compose.
- Detail the data flows for user login, message send/receive, presence updates, image upload.
- Don’t over-complicate—focus on the four main services and how they interact.

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "Docker Compose Orchestration"
        direction TB
        Compose["Docker Compose"]:::orchestration
        subgraph "Client Service"
            direction TB
            ReactApp["React Frontend"]:::frontend
            Components["components/"]:::frontend
            Context["context/AccountProvider.jsx"]:::frontend
            APIService["service/api.js"]:::frontend
        end
        subgraph "Backend API Service"
            direction TB
            ExpressAPI["Express REST API"]:::backend
            IndexAPI["index.js"]:::backend
            Routes["routes/route.js"]:::backend
            Controllers["controller/"]:::backend
            Models["model/"]:::backend
            DBConn["database/db.js"]:::backend
            UploadUtil["utils/upload.js"]:::backend
        end
        subgraph "Socket Service"
            direction TB
            SocketServer["Socket.io Server"]:::realtime
            SocketIndex["index.js"]:::realtime
        end
        subgraph "Database"
            direction TB
            MongoDB["MongoDB"]:::database
        end
    end

    %% Connections
    ReactApp -->|"HTTP REST"| ExpressAPI
    ReactApp -->|"""WebSocket Events"""| SocketServer
    ExpressAPI -->|"CRUD Operations"| MongoDB
    SocketServer -->|"Persist Messages"| MongoDB
    Compose --> ReactApp
    Compose --> ExpressAPI
    Compose --> SocketServer
    Compose --> MongoDB

    %% Sub-component links
    ReactApp --> Components
    ReactApp --> Context
    ReactApp --> APIService

    ExpressAPI --> IndexAPI
    ExpressAPI --> Routes
    ExpressAPI --> Controllers
    ExpressAPI --> Models
    ExpressAPI --> DBConn
    ExpressAPI --> UploadUtil

    SocketServer --> SocketIndex

    %% Click Events
    click ReactApp "https://github.com/vinayak409/whatsapp-clone-mern-stack/tree/master/client/"
    click Components "https://github.com/vinayak409/whatsapp-clone-mern-stack/tree/master/client/src/components/"
    click Context "https://github.com/vinayak409/whatsapp-clone-mern-stack/blob/master/client/src/context/AccountProvider.jsx"
    click APIService "https://github.com/vinayak409/whatsapp-clone-mern-stack/blob/master/client/src/service/api.js"

    click ExpressAPI "https://github.com/vinayak409/whatsapp-clone-mern-stack/tree/master/server/"
    click IndexAPI "https://github.com/vinayak409/whatsapp-clone-mern-stack/blob/master/server/index.js"
    click Routes "https://github.com/vinayak409/whatsapp-clone-mern-stack/blob/master/server/routes/route.js"
    click Controllers "https://github.com/vinayak409/whatsapp-clone-mern-stack/tree/master/server/controller/"
    click Models "https://github.com/vinayak409/whatsapp-clone-mern-stack/tree/master/server/model/"
    click DBConn "https://github.com/vinayak409/whatsapp-clone-mern-stack/blob/master/server/database/db.js"
    click UploadUtil "https://github.com/vinayak409/whatsapp-clone-mern-stack/blob/master/server/utils/upload.js"

    click SocketServer "https://github.com/vinayak409/whatsapp-clone-mern-stack/tree/master/socket/"
    click SocketIndex "https://github.com/vinayak409/whatsapp-clone-mern-stack/blob/master/socket/index.js"

    click MongoDB "https://github.com/vinayak409/whatsapp-clone-mern-stack/blob/master/server/docker-compose.yml"
    click Compose "https://github.com/vinayak409/whatsapp-clone-mern-stack/blob/master/server/docker-compose.yml"

    %% Styles
    classDef frontend fill:#E0F7FA,stroke:#006064,color:#000
    classDef backend fill:#E8F5E9,stroke:#2E7D32,color:#000
    classDef realtime fill:#FFF3E0,stroke:#EF6C00,color:#000
    classDef database fill:#F3E5F5,stroke:#6A1B9A,color:#000
    classDef orchestration fill:#ECEFF1,stroke:#546E7A,color:#000
```
