# siddharthssb11/text-a-lot architecture

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

- Interactive diagram: https://gitdiagram.com/siddharthssb11/text-a-lot
- Repository: https://github.com/siddharthssb11/text-a-lot

## Overview

##### Project Type and Purpose
- This is a full-stack, real-time chat web application built on the MERN stack (MongoDB, Express, React, Node) with Socket.IO for live messaging.
- Frontend: React (hooks, Context API) bundled via Webpack/Babel.
- Backend: Node.js + Express providing RESTful endpoints and WebSocket (Socket.IO) real-time channels.
- Data store: MongoDB Atlas.
- Deployed on Heroku (Procfile, postbuild script).

##### File Structure
- Top-level:
– backend/ – Node/Express server
- config/ (db connection, JWT token generation)
- controllers/ (chat, message, user controllers)
- models/ (Mongoose schemas)
- routes/ (REST endpoints)
- middleware/ (auth, error handling)
- server.js (app & Socket.IO bootstrap)
– frontend/ – React client
- public/ (static HTML, manifest)
- src/
· Context/ (ChatProvider, context hooks)
· Pages/ (HomePage, ChatPage)
· components/ (Auth forms, Chat UI, modals, loading, error boundary)
· config/ (helper functions, chat logic)
- Root: Procfile (Heroku), package.json, README.md, screenshots/

##### README Insights
- Confirms MERN+Socket.IO stack, mentions JWT auth, MongoDB Atlas, React hooks, ES6+.
- Highlights features: one-on-one & group chat, typing indicators, online/offline status, read receipts.
- Environment variables for .env (PORT, MONGO_URI, JWT_SECRET).
- Run/dev instructions, Heroku deployment.

##### Main Components & Their Interactions
a. Frontend Application (React)
– UI Pages and Components
– Chat Context (state management)
– HTTP client for REST calls to backend (Auth, fetch chats/messages)
– WebSocket client for real-time events (connect, join chat room, typing events, new message notifications)
b. Backend Server (Node/Express + Socket.IO)
– REST API Layer (userRoutes, chatRoutes, messageRoutes) → controllers → models → MongoDB
– Socket.IO Layer (in server.js): listens for “connection”, “join_chat”, “typing”, “new_message” events, broadcasts to appropriate rooms
– Middleware: authMiddleware (JWT validation), errorMiddleware
c. Database (MongoDB Atlas)
– Collections: users, chats, messages
d. External/Infrastructure
– Heroku hosting (Procfile triggers `npm run postbuild`)
– Environment variables (.env)
– Webpack/Babel build pipeline for frontend

##### Architectural Patterns & Design Principles
- Frontend: Component-based UI, unidirectional data flow via Context.
- Backend: MVC-inspired separation (routes → controllers → models), middleware for cross-cutting concerns.
- Real‐time event-driven layer with Socket.IO.
- Layered architecture:
– Presentation (React)
– API/WebSocket (Express + Socket.IO)
– Business logic (controllers, services)
– Persistence (MongoDB)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "React Client" 
        direction TB
        FE_Entry["Index & App Entry"]:::frontend
        FE_Public["Static Assets (HTML, Manifest)"]:::frontend
        FE_Animations["Typing Animations"]:::frontend
        subgraph "Pages & UI" 
            direction TB
            FE_Home["HomePage"]:::frontend
            FE_ChatPage["ChatPage"]:::frontend
            subgraph "Components" 
                direction TB
                FE_Login["Login Form"]:::frontend
                FE_Signup["Signup Form"]:::frontend
                FE_ChatBox["ChatBox"]:::frontend
                FE_MyChats["MyChats"]:::frontend
                FE_SingleChat["SingleChat"]:::frontend
                FE_ScrollableChat["ScrollableChat"]:::frontend
                FE_ChatLoading["ChatLoading"]:::frontend
                FE_GroupModal["GroupChatModal"]:::frontend
                FE_UpdateGroup["UpdateGroupChatModal"]:::frontend
                FE_ProfileModal["ProfileModal"]:::frontend
                FE_SideDrawer["SideDrawer"]:::frontend
                FE_ErrorBoundary["ErrorBoundary"]:::frontend
                FE_UserBadge["UserBadgeItem"]:::frontend
                FE_UserListItem["UserListItem"]:::frontend
            end
        end
        subgraph "Context & Config"
            direction TB
            FE_Context["ChatProvider & Hooks"]:::frontend
            FE_Config["ChatLogics & Helpers"]:::frontend
        end
        %% Clicks
        click FE_Entry "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/index.js"
        click FE_Entry "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/App.js"
        click FE_Entry "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/App.css"
        click FE_Public "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/public/index.html"
        click FE_Public "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/public/manifest.json"
        click FE_Public "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/public/robots.txt"
        click FE_Animations "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/animations/typing.json"
        click FE_Home "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/Pages/HomePage.js"
        click FE_ChatPage "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/Pages/ChatPage.js"
        click FE_Login "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/Authentication/Login.js"
        click FE_Signup "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/Authentication/Signup.js"
        click FE_ChatBox "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/ChatBox.js"
        click FE_MyChats "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/MyChats.js"
        click FE_SingleChat "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/SingleChat.js"
        click FE_ScrollableChat "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/ScrollableChat.js"
        click FE_ChatLoading "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/ChatLoading.js"
        click FE_GroupModal "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/miscellaneous/GroupChatModal.js"
        click FE_UpdateGroup "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/miscellaneous/UpdateGroupChatModal.js"
        click FE_ProfileModal "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/miscellaneous/ProfileModal.js"
        click FE_SideDrawer "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/miscellaneous/SideDrawer.js"
        click FE_ErrorBoundary "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/ErrorBoundary.js"
        click FE_UserBadge "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/userAvatar/UserBadgeItem.js"
        click FE_UserListItem "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/components/userAvatar/UserListItem.js"
        click FE_Context "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/Context/ChatProvider.js"
        click FE_Context "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/Context/chat-context.js"
        click FE_Config "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/config/ChatLogics.js"
        click FE_Config "https://github.com/siddharthssb11/text-a-lot/blob/master/frontend/src/config/helper-hook.js"
    end

    %% Backend Layer
    subgraph "Heroku Platform" 
        direction TB
        infra["Environment & Procfile"]:::infra
        click infra "https://github.com/siddharthssb11/text-a-lot/tree/master/Procfile"
        subgraph "Node/Express Server" 
            direction TB
            BE_Server["server.js (Express & Socket.IO)"]:::backend
            click BE_Server "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/server.js"
            subgraph "REST API" 
                direction TB
                BE_Routes["Routes"]:::backend
                click BE_Routes "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/routes/userRoutes.js"
                click BE_Routes "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/routes/chatRoutes.js"
                click BE_Routes "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/routes/messageRoutes.js"
                BE_Controllers["Controllers"]:::backend
                click BE_Controllers "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/controllers/userControllers.js"
                click BE_Controllers "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/controllers/chatControllers.js"
                click BE_Controllers "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/controllers/messageControllers.js"
                BE_Models["Models"]:::backend
                click BE_Models "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/models/userModel.js"
                click BE_Models "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/models/chatModel.js"
                click BE_Models "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/models/messageModel.js"
                BE_Middleware["Middleware"]:::backend
                click BE_Middleware "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/middleware/authMiddleware.js"
                click BE_Middleware "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/middleware/errorMiddleware.js"
            end
            subgraph "WebSocket (Socket.IO)" 
                direction TB
                BE_WS["Socket.IO Handlers"]:::realTime
            end
            BE_Config["Config"]:::backend
            click BE_Config "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/config/db.js"
            click BE_Config "https://github.com/siddharthssb11/text-a-lot/blob/master/backend/config/generateToken.js"
        end
        infra --> BE_Server
        BE_Server --> BE_Routes
        BE_Routes --> BE_Controllers
        BE_Controllers --> BE_Models
        BE_Middleware --> BE_Controllers
    end

    %% Database
    DB["MongoDB Atlas"]:::db

    %% Data Flows
    FE_Entry -->|"HTTP REST Calls"| BE_Routes
    FE_Entry -->|"WebSocket Connect"| BE_WS
    BE_Controllers -->|"CRUD Operations"| DB
    BE_WS -->|"Persist Messages"| DB

    %% Client Flows
    FE_Context --> FE_Entry
    FE_Context --> FE_Home
    FE_Context --> FE_ChatPage

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#004085,color:#004085
    classDef backend fill:#d4edda,stroke:#155724,color:#155724
    classDef db fill:#fff3cd,stroke:#856404,color:#856404
    classDef infra fill:#e2e3e5,stroke:#6c757d,color:#6c757d
    classDef realTime fill:#f8d7da,stroke:#721c24,color:#721c24
```
