# khushhal-soni/chat-app architecture

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

- Interactive diagram: https://gitdiagram.com/khushhal-soni/chat-app
- Repository: https://github.com/khushhal-soni/chat-app

## Overview

##### Project type and purpose
- This is a full-stack, real-time chat application (“chat-app”).
- Frontend: built with React + Vite + TailwindCSS, uses Context and custom hooks.
- Backend: Node.js + Express REST API + Socket.io for real-time messaging, MongoDB via Mongoose for persistence.

##### File structure
- Top-level separation:
– backend/ (Express server, controllers, routes, models, socket logic, DB connection)
– frontend/ (React app, components, pages, hooks, context, assets, config)
- Backend follows MVC-ish pattern:
– models/ define Mongoose schemas (User, Conversation, Message)
– controllers/ implement business logic (auth, user, message)
– routes/ wire HTTP endpoints to controllers (/auth, /user, /message)
– middleware/ for route protection (JWT auth)
– socket/ holds socket.io event handlers
- Frontend owns:
– src/pages/ (Login, Signup, Home)
– src/components/ (Sidebar, Conversations, Messages, Inputs)
– src/context/ and src/zustand/ for global state (AuthContext, SocketContext, conversation store)
– src/hooks/ wrap API calls and socket listeners (useLogin, useSendMessage, useListenMessages, etc.)

##### README
- README only states “# chat-app,” so rely on file tree to infer architecture.

a. Main components:
1. Browser/Client: React SPA
2. HTTP API Server: Express app with REST endpoints
3. WebSocket Server: Socket.io instance on the same server
4. Database: MongoDB (Atlas or self-hosted)
5. Authentication: JWT generation/verification utility
b. Relationships and data flow:
– User interacts with React UI → triggers HTTP calls (/auth/login, /auth/signup)
– Upon login, client stores JWT and opens WebSocket connection
– Sending a message: React hook → emits socket event to backend → backend writes to MongoDB → backend emits socket event back to all clients in that conversation → React clients update UI
– Fetch history: React hook → GET /message/:conversationId → Express controller → Mongoose query → returns JSON to client
c. Architectural patterns and design principles:
– Backend: MVC separation (models/controllers/routes), middleware for cross-cutting concerns, single server handling both REST and WebSocket
– Frontend: Component-driven UI, Context & Zustand for state, custom hooks for side effects (API, sockets)
– Real-time: publish-subscribe pattern via Socket.io rooms (conversations mapped to rooms)
d. Technologies and frameworks:
– Backend: Node.js, Express, Socket.io, Mongoose, JSON Web Tokens
– Frontend: React, Vite, Tailwind CSS, PostCSS, Zustand, Context API
– Database: MongoDB

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    subgraph "Browser/Client (React SPA)" 
        direction TB
        ClientPages["Pages\n• Home\n• Login\n• SignUp"]:::ui
        ClientComponents["Components\n• Sidebar\n• Conversation Item\n• Messages\n• MessageInput\n• Message"]:::ui
        ClientContexts["Contexts\n• AuthContext\n• SocketContext"]:::ui
        ClientHooks["Hooks\n• useLogin\n• useSignup\n• useGetConversations\n• useGetMessages\n• useSendMessage\n• useListenMessages"]:::ui
        ClientZustand["Zustand Store\n• useConversation"]:::ui
        ClientUtils["Utils\n• emojis\n• extractTime"]:::ui
    end

    %% Backend Layer
    subgraph "Backend Server (Node.js/Express + Socket.io)" 
        direction TB
        APIEntry["Express Server\n(server.js)"]:::server
        subgraph "REST API" 
            direction TB
            AuthRoutes["Auth Routes\nPOST /auth/login\nPOST /auth/signup"]:::server
            UserRoutes["User Routes\nGET/PUT /user"]:::server
            MessageRoutes["Message Routes\nGET /message/:id"]:::server
            Protect["Middleware\nprotectRoute (JWT)"]:::server
            AuthController["AuthController"]:::server
            UserController["UserController"]:::server
            MessageController["MessageController"]:::server
            AuthUtil["JWT Util\ngenerateToken"]:::server
        end
        subgraph "WebSocket (Socket.io)" 
            direction TB
            SocketEntry["Socket Handlers\n(socket.js)"]:::server
        end
        DBConnect["DB Connection\n(connectToMongoDB)"]:::server
        subgraph "Models (Mongoose)" 
            direction TB
            UserModel["User Model"]:::server
            ConversationModel["Conversation Model"]:::server
            MessageModel["Message Model"]:::server
        end
    end

    %% Database Layer
    MongoDB["MongoDB"]:::db

    %% Connections
    ClientPages -->|uses| APIEntry
    ClientComponents -->|calls| APIEntry
    ClientHooks -->|HTTP Requests| APIEntry
    ClientHooks -->|WebSocket Emits/Listeners| SocketEntry
    ClientContexts -->|provides| ClientComponents

    APIEntry -->|uses routes| AuthRoutes
    APIEntry -->|uses routes| UserRoutes
    APIEntry -->|uses routes| MessageRoutes
    AuthRoutes -->|calls| AuthController
    UserRoutes -->|protectRoute| Protect
    MessageRoutes -->|protectRoute| Protect
    Protect -->|validates JWT| AuthUtil
    AuthController -->|CRUD| UserModel
    UserController -->|CRUD| UserModel
    MessageController -->|CRUD| MessageModel
    MessageController -->|CRUD| ConversationModel
    AuthController -->|generates JWT| AuthUtil

    SocketEntry -->|on connection| AuthUtil
    SocketEntry -->|writes| MessageModel
    SocketEntry -->|writes| ConversationModel
    SocketEntry -->|emits| ConversationModel

    DBConnect -->|connect| MongoDB
    UserModel -->|schema| MongoDB
    ConversationModel -->|schema| MongoDB
    MessageModel -->|schema| MongoDB
    MessageController -->|queries| MongoDB
    AuthController -->|queries| MongoDB
    UserController -->|queries| MongoDB
    SocketEntry -->|queries| MongoDB

    %% Auth flow dashed
    ClientHooks -.->|"attach JWT"| APIEntry

    %% Click Events
    click ClientPages "https://github.com/khushhal-soni/chat-app/tree/main/frontend/src/pages"
    click ClientComponents "https://github.com/khushhal-soni/chat-app/tree/main/frontend/src/components"
    click ClientContexts "https://github.com/khushhal-soni/chat-app/tree/main/frontend/src/context"
    click ClientHooks "https://github.com/khushhal-soni/chat-app/tree/main/frontend/src/hooks"
    click ClientZustand "https://github.com/khushhal-soni/chat-app/blob/main/frontend/src/zustand/useConversation.js"
    click ClientUtils "https://github.com/khushhal-soni/chat-app/tree/main/frontend/src/utils"

    click APIEntry "https://github.com/khushhal-soni/chat-app/blob/main/backend/server.js"
    click AuthRoutes "https://github.com/khushhal-soni/chat-app/blob/main/backend/routes/auth.routes.js"
    click UserRoutes "https://github.com/khushhal-soni/chat-app/blob/main/backend/routes/user.routes.js"
    click MessageRoutes "https://github.com/khushhal-soni/chat-app/blob/main/backend/routes/message.routes.js"
    click Protect "https://github.com/khushhal-soni/chat-app/blob/main/backend/middleware/protectRoute.js"
    click AuthController "https://github.com/khushhal-soni/chat-app/blob/main/backend/controllers/auth.controller.js"
    click UserController "https://github.com/khushhal-soni/chat-app/blob/main/backend/controllers/user.controller.js"
    click MessageController "https://github.com/khushhal-soni/chat-app/blob/main/backend/controllers/message.controller.js"
    click AuthUtil "https://github.com/khushhal-soni/chat-app/blob/main/backend/utils/generateToken.js"
    click SocketEntry "https://github.com/khushhal-soni/chat-app/blob/main/backend/socket/socket.js"
    click DBConnect "https://github.com/khushhal-soni/chat-app/blob/main/backend/db/connectToMongoDB.js"
    click UserModel "https://github.com/khushhal-soni/chat-app/blob/main/backend/models/user.model.js"
    click ConversationModel "https://github.com/khushhal-soni/chat-app/blob/main/backend/models/conversation.model.js"
    click MessageModel "https://github.com/khushhal-soni/chat-app/blob/main/backend/models/message.model.js"

    %% Styles
    classDef ui fill:#bbdefb,stroke:#1e88e5,color:#0d47a1
    classDef server fill:#c8e6c9,stroke:#43a047,color:#1b5e20
    classDef db fill:#ffe0b2,stroke:#fb8c00,color:#e65100
```
