# monametsi-s/chat-app architecture

> Architecture diagram of the GitHub repository monametsi-s/chat-app, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-24). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/monametsi-s/chat-app
- Repository: https://github.com/monametsi-s/chat-app

## Overview

##### Project Type and Purpose
- This is a full-stack real-time chat application built on the MERN stack (MongoDB, Express, React, Node.js).
- It provides secure user authentication, JWT-based authorization, a RESTful API for user/message management, and real-time messaging via Socket.IO.
- The frontend uses React+Tailwind+Zustand for UI, state management, and theming. The backend uses Express, Mongoose, and Socket.IO for API and WebSocket handling.

##### File Structure
- Top-level folders:
– backend/: Node/Express server code
– frontend/: React single page application
- backend/src subdirectories reveal an MVC-style split:
– controllers/ for business logic (auth, messaging)
– routes/ for Express endpoints
– models/ for Mongoose schemas
– middleware/ for auth checks and error handling
– lib/ for utilities (DB connection, Cloudinary, Socket setup, etc.)
– seeds/ for initial data
- frontend/src modules follow a component-driven approach:
– components/ reusable UI pieces (ChatContainer, Sidebar, etc.)
– pages/ top-level routes (Login, Signup, Home, Profile, Settings)
– store/ global state (auth, chat, theme)
– lib/ axios instance and helper functions
- Config files:
– dotenv (.env) for environment variables
– Vite and Tailwind configuration for frontend build
– package.json scripts for dev/prod

##### README for Additional Insights
- Tech stack confirms libraries and frameworks in use.
- Features section highlights critical flows: signup/login → token issuance → protected REST APIs → socket connections → real-time broadcast.
- Socket.IO section clarifies event channels (e.g., connection, message send/receive).
- Folder structure in README mirrors file tree, validating MVC + component-based frontend.

a. Main Components
– Client (React SPA)
– API Gateway (Express server)
– Authentication Service (bcrypt + JWT middleware)
– WebSocket Service (Socket.IO)
– Database (MongoDB via Mongoose)
– External Storage (Cloudinary for optional image uploads)
– State Management (Zustand stores on client)
b. Relationships and Interactions
1. Client sends HTTP requests (login/signup, fetch chats) → API Gateway
2. API Gateway authenticates via JWT middleware → Issues tokens
3. Client connects to WebSocket endpoint with token → Socket.IO Service
4. Socket.Service emits/receives message events → stores to DB → broadcasts to other clients
5. DB persists user and message documents
6. Client optionally uploads images → API Gateway → Cloudinary → returns image URL
c. Architectural Patterns
– MVC on backend: separates models, controllers, routes
– Component-based UI on frontend
– Centralized state management (Zustand)
– Pub/Sub via Socket.IO for real-time updates
– Middleware pipeline for auth and error handling
d. Key Technologies
– Express & Node.js for REST API
– Socket.IO for WebSocket communication
– MongoDB/Mongoose for data persistence
– React, Tailwind CSS, DaisyUI for UI
– Zustand for global client state
– bcryptjs & JWT for security
– Cloudinary SDK for media management

## Diagram (Mermaid)

```mermaid
graph TD
    %% Frontend Layer
    subgraph "Frontend (React SPA)"
        FR_Client["React SPA"]:::frontend
        subgraph UI
            FR_Components["UI Components"]:::frontend
            FR_Pages["Page Routes"]:::frontend
        end
        subgraph State
            FR_AuthStore["Auth Store"]:::frontend
            FR_ChatStore["Chat Store"]:::frontend
            FR_ThemeStore["Theme Store"]:::frontend
        end
        subgraph "Frontend Lib"
            FR_Axios["API Client (Axios)"]:::frontend
            FR_Utils["Utilities"]:::frontend
        end
        subgraph Config
            TW["Tailwind Config"]:::frontend
            VITE["Vite Config"]:::frontend
        end
        FR_Client --> FR_Components
        FR_Components --> FR_Pages
        FR_Client --> FR_AuthStore
        FR_AuthStore --> FR_ChatStore
        FR_ChatStore --> FR_ThemeStore
        FR_Client --> FR_Axios
        FR_Client --> FR_Utils
        FR_Client --> TW
        FR_Client --> VITE
    end

    %% Backend Layer
    subgraph "Backend (Express API)"
        BE_API["API Gateway\n(Express server)"]:::backend
        subgraph Controllers
            AuthController["Auth Controller"]:::backend
            MsgController["Message Controller"]:::backend
        end
        subgraph Routes
            AuthRoute["Auth Routes"]:::backend
            MsgRoute["Message Routes"]:::backend
        end
        subgraph Middleware
            JWTMiddleware["JWT Middleware"]:::backend
            ErrorMiddleware["Error Handler"]:::backend
        end
        subgraph Services
            SocketService["WebSocket Service\n(Socket.IO)"]:::realtime
            CloudinaryService["Cloudinary Service"]:::external
        end
        subgraph Models
            UserModel["User Model"]:::db
            MessageModel["Message Model"]:::db
        end
        subgraph "DB & Utils"
            DBConn["DB Connection"]:::db
            BE_Utils["Backend Utilities"]:::backend
            SeedData["Seed Data"]:::backend
        end

        BE_API -->|"HTTP/HTTPS"| AuthController
        BE_API -->|"HTTP/HTTPS"| MsgController
        BE_API --> JWTMiddleware
        BE_API --> ErrorMiddleware
        AuthController --> AuthRoute
        MsgController --> MsgRoute
        AuthRoute --> JWTMiddleware
        MsgRoute --> JWTMiddleware
        BE_API --> CloudinaryService
        AuthController --> DBConn
        MsgController --> DBConn
        SocketService ---|"WS/WSS"| BE_API
        SocketService --> DBConn
        DBConn --> UserModel
        DBConn --> MessageModel
    end

    %% Client-Server Interaction
    FR_Client -->|HTTPS| BE_API

    %% Styles
    classDef frontend fill:#D0E8FF,stroke:#0366d6,color:#0366d6;
    classDef backend fill:#D2F8D2,stroke:#02733e,color:#02733e;
    classDef realtime fill:#FFE8A6,stroke:#d9822b,color:#d9822b;
    classDef db fill:#E0E0E0,stroke:#555,color:#333;
    classDef external fill:#F0F0F0,stroke:#777,color:#555;

    %% Click Events
    click FR_Client "https://github.com/monametsi-s/chat-app/tree/main/frontend/src/"
    click BE_API "https://github.com/monametsi-s/chat-app/blob/main/backend/src/index.js"
    click AuthController "https://github.com/monametsi-s/chat-app/blob/main/backend/src/controllers/auth.controller.js"
    click AuthRoute "https://github.com/monametsi-s/chat-app/blob/main/backend/src/routes/auth.route.js"
    click JWTMiddleware "https://github.com/monametsi-s/chat-app/blob/main/backend/src/middleware/auth.middleware.js"
    click SocketService "https://github.com/monametsi-s/chat-app/blob/main/backend/src/lib/socket.js"
    click MsgController "https://github.com/monametsi-s/chat-app/blob/main/backend/src/controllers/message.controller.js"
    click MsgRoute "https://github.com/monametsi-s/chat-app/blob/main/backend/src/routes/message.route.js"
    click DBConn "https://github.com/monametsi-s/chat-app/blob/main/backend/src/lib/db.js"
    click UserModel "https://github.com/monametsi-s/chat-app/blob/main/backend/src/models/user.model.js"
    click MessageModel "https://github.com/monametsi-s/chat-app/blob/main/backend/src/models/message.model.js"
    click CloudinaryService "https://github.com/monametsi-s/chat-app/blob/main/backend/src/lib/cloudinary.js"
    click BE_Utils "https://github.com/monametsi-s/chat-app/blob/main/backend/src/lib/utils.js"
    click SeedData "https://github.com/monametsi-s/chat-app/blob/main/backend/src/seeds/user.seed.js"
    click FR_Components "https://github.com/monametsi-s/chat-app/tree/main/frontend/src/components/"
    click FR_Pages "https://github.com/monametsi-s/chat-app/tree/main/frontend/src/pages/"
    click FR_AuthStore "https://github.com/monametsi-s/chat-app/blob/main/frontend/src/store/useAuthStore.js"
    click FR_ChatStore "https://github.com/monametsi-s/chat-app/blob/main/frontend/src/store/useChatStore.jsx"
    click FR_ThemeStore "https://github.com/monametsi-s/chat-app/blob/main/frontend/src/store/useThemeStore.js"
    click FR_Axios "https://github.com/monametsi-s/chat-app/blob/main/frontend/src/lib/axios.js"
    click FR_Utils "https://github.com/monametsi-s/chat-app/blob/main/frontend/src/lib/utils.js"
    click TW "https://github.com/monametsi-s/chat-app/blob/main/frontend/tailwind.config.js"
    click VITE "https://github.com/monametsi-s/chat-app/blob/main/frontend/vite.config.js"
```
