# 58tinkal/chatt_app architecture

> Architecture diagram of the GitHub repository 58tinkal/chatt_app, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/58tinkal/chatt_app
- Repository: https://github.com/58tinkal/chatt_app

## Overview

##### Project Type & Purpose
- This is a full-stack MERN chat application with real-time messaging, user authentication (JWT), one-to-one and group chats, built-in Socket.io.
- Frontend: React + Chakra UI, state via React Context, communicates over REST and WebSockets.
- Backend: Node.js + Express + Mongoose, exposes REST endpoints under `/api/user`, `/api/chat`, `/api/message`, and hosts a Socket.io real-time layer.
- Database: MongoDB (via Mongoose) for users, chats, messages.

##### High-Level File Structure & Architectural Patterns
- Root
- package.json – scripts to start backend (`npm start`), build frontend (`npm run build`).
- /backend
- config/ – DB connection (db.js), JWT token generator (generateToken.js)
- middleware/ – auth (JWT validation), error handlers
- models/ – Mongoose schemas (User, Chat, Message)
- controllers/ – business logic for users, chats, messages
- routes/ – Express routers mounted on `/api/*`
- server.js – Express app bootstrapping, Socket.io initialization
- /frontend
- public/ – static HTML, manifest, robots.txt
- src/ – React entry (index.js), App.js (Router), Context (ChatProvider), Pages (Homepage, Chatpage), UI components (Chatbox, SideDrawer, modals), config utilities, sample data.
- build/ & dist/ – production bundles
- Patterns
- Layered architecture (Presentation → Business Logic → Data Access)
- Context for global state
- REST + WebSocket hybrid

##### Main Components & Their Interactions
- Client Browser (React SPA)
- Sends HTTP(S) requests to Express API (user auth, fetch chats/messages)
- Opens WebSocket connection to Socket.io server for real-time events (typing, newMessage)
- Express Server
- REST layer: userRoutes, chatRoutes, messageRoutes → controllers → models → MongoDB
- Socket.io layer: listens for client events, emits updates to relevant sockets
- JWT middleware: secures REST endpoints
- MongoDB
- Collections: users, chats, messages
- Mongoose ORM handles schema & population of references
- External Services
- Browser localStorage (persists JWT)
- Potential future: file storage, push notifications

##### Architectural Patterns & Design Principles
- Separation of concerns: UI, service layer, data layer
- Single Page Application assisted by React Router
- Real-time pub/sub via WebSockets (Socket.io)
- Token-based authentication (JWT)
- MVC-style on backend (Routes → Controllers → Models)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Clients Layer
    subgraph "Clients" 
        direction TB
        Browser["Client Browser (React SPA)"]:::external
    end

    %% Frontend Layer
    subgraph "Frontend Container" 
        direction TB
        FE_Index["Entry Point\nindex.js"]:::frontend
        FE_App["App.js (Router)"]:::frontend
        FE_Context["ChatProvider.js"]:::frontend
        subgraph "Pages" 
            direction TB
            FE_Home["Homepage.js"]:::frontend
            FE_ChatPage["Chatpage.js"]:::frontend
        end
        subgraph "UI Components"
            direction TB
            FE_Chatbox["Chatbox.js"]:::frontend
            FE_MyChats["MyChats.js"]:::frontend
            FE_ScrollableChat["ScrollableChat.js"]:::frontend
            FE_SingleChat["SingleChat.js"]:::frontend
            FE_ChatLoading["ChatLoading.js"]:::frontend
            subgraph "Authentication"
                direction TB
                FE_Login["Login.js"]:::frontend
                FE_Signup["Signup.js"]:::frontend
            end
            subgraph "Miscellaneous Modals & Drawers"
                direction TB
                FE_SideDrawer["SideDrawer.js"]:::frontend
                FE_GroupChatModal["GroupChatModal.js"]:::frontend
                FE_ProfileModal["ProfileModal.js"]:::frontend
                FE_UpdateGroupChatModal["UpdateGroupChatModal.js"]:::frontend
            end
            subgraph "User Avatar Items"
                direction TB
                FE_UserBadgeItem["UserBadgeItem.js"]:::frontend
                FE_UserListItem["UserListItem.js"]:::frontend
            end
        end
        FE_Config["ChatLogics.js (API & Socket Client)"]:::frontend
        FE_Anim["typing.json"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend Container"
        direction TB
        BE_Server["server.js\n(Socket.io Init)"]:::backend
        subgraph "Config"
            direction TB
            BE_DBConfig["db.js"]:::backend
            BE_GenToken["generateToken.js"]:::backend
        end
        subgraph "Middleware"
            direction TB
            BE_AuthMW["authMiddleware.js"]:::backend
            BE_ErrorMW["errorMiddleware.js"]:::backend
        end
        subgraph "Models"
            direction TB
            BE_UserModel["userModel.js"]:::backend
            BE_ChatModel["chatModel.js"]:::backend
            BE_MessageModel["messageModel.js"]:::backend
        end
        subgraph "Controllers"
            direction TB
            BE_UserCtrl["userControllers.js"]:::backend
            BE_ChatCtrl["chatControllers.js"]:::backend
            BE_MessageCtrl["messageControllers.js"]:::backend
        end
        subgraph "Routes"
            direction TB
            BE_UserRoutes["userRoutes.js\n(/api/user)"]:::backend
            BE_ChatRoutes["chatRoutes.js\n(/api/chat)"]:::backend
            BE_MessageRoutes["messageRoutes.js\n(/api/message)"]:::backend
        end
    end

    %% Data Layer
    MongoDB[(MongoDB)]:::database

    %% Connections
    Browser -->|HTTP REST| FE_App
    FE_App -->|calls API| FE_Config
    FE_Config -->|POST /api/user/login| BE_UserRoutes
    FE_Config -->|GET /api/chat| BE_ChatRoutes
    FE_Config -->|GET /api/message| BE_MessageRoutes
    Browser -->|WebSocket connect| BE_Server
    BE_Server -->|listens emits| Browser
    BE_UserRoutes -->|uses| BE_UserCtrl
    BE_ChatRoutes -->|uses| BE_ChatCtrl
    BE_MessageRoutes -->|uses| BE_MessageCtrl
    BE_UserCtrl -->|CRUD| BE_UserModel
    BE_ChatCtrl -->|CRUD| BE_ChatModel
    BE_MessageCtrl -->|CRUD| BE_MessageModel
    BE_UserModel -->|queries| MongoDB
    BE_ChatModel -->|queries| MongoDB
    BE_MessageModel -->|queries| MongoDB
    BE_Server -->|use| BE_AuthMW
    BE_Server -->|use| BE_ErrorMW

    %% JWT Flow
    Browser -->|stores JWT| FE_Context
    FE_Config -->|Authorization header| BE_AuthMW
    BE_AuthMW -->|validates token| BE_GenToken

    %% Click Events
    click FE_Index "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/index.js"
    click FE_App "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/App.js"
    click FE_Context "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/Context/ChatProvider.js"
    click FE_Home "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/Pages/Homepage.js"
    click FE_ChatPage "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/Pages/Chatpage.js"
    click FE_Chatbox "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/Chatbox.js"
    click FE_MyChats "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/MyChats.js"
    click FE_ScrollableChat "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/ScrollableChat.js"
    click FE_SingleChat "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/SingleChat.js"
    click FE_ChatLoading "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/ChatLoading.js"
    click FE_Login "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/Authentication/Login.js"
    click FE_Signup "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/Authentication/Signup.js"
    click FE_SideDrawer "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/miscellaneous/SideDrawer.js"
    click FE_GroupChatModal "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/miscellaneous/GroupChatModal.js"
    click FE_ProfileModal "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/miscellaneous/ProfileModal.js"
    click FE_UpdateGroupChatModal "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/miscellaneous/UpdateGroupChatModal.js"
    click FE_UserBadgeItem "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/userAvatar/UserBadgeItem.js"
    click FE_UserListItem "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/components/userAvatar/UserListItem.js"
    click FE_Config "https://github.com/58tinkal/chatt_app/blob/main/frontend/src/config/ChatLogics.js"
    click BE_Server "https://github.com/58tinkal/chatt_app/blob/main/backend/server.js"
    click BE_DBConfig "https://github.com/58tinkal/chatt_app/blob/main/backend/config/db.js"
    click BE_GenToken "https://github.com/58tinkal/chatt_app/blob/main/backend/config/generateToken.js"
    click BE_AuthMW "https://github.com/58tinkal/chatt_app/blob/main/backend/middleware/authMiddleware.js"
    click BE_ErrorMW "https://github.com/58tinkal/chatt_app/blob/main/backend/middleware/errorMiddleware.js"
    click BE_UserModel "https://github.com/58tinkal/chatt_app/blob/main/backend/models/userModel.js"
    click BE_ChatModel "https://github.com/58tinkal/chatt_app/blob/main/backend/models/chatModel.js"
    click BE_MessageModel "https://github.com/58tinkal/chatt_app/blob/main/backend/models/messageModel.js"
    click BE_UserCtrl "https://github.com/58tinkal/chatt_app/blob/main/backend/controllers/userControllers.js"
    click BE_ChatCtrl "https://github.com/58tinkal/chatt_app/blob/main/backend/controllers/chatControllers.js"
    click BE_MessageCtrl "https://github.com/58tinkal/chatt_app/blob/main/backend/controllers/messageControllers.js"
    click BE_UserRoutes "https://github.com/58tinkal/chatt_app/blob/main/backend/routes/userRoutes.js"
    click BE_ChatRoutes "https://github.com/58tinkal/chatt_app/blob/main/backend/routes/chatRoutes.js"
    click BE_MessageRoutes "https://github.com/58tinkal/chatt_app/blob/main/backend/routes/messageRoutes.js"

    %% Styles
    classDef external fill:#cccccc,stroke:#333,stroke-width:1px
    classDef frontend fill:#cce5ff,stroke:#004085,stroke-width:1px
    classDef backend fill:#d4edda,stroke:#155724,stroke-width:1px
    classDef database fill:#fff3cd,stroke:#856404,stroke-width:1px
```
