# yashu1113/real-time-chat-app architecture

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

- Interactive diagram: https://gitdiagram.com/yashu1113/real-time-chat-app
- Repository: https://github.com/yashu1113/real-time-chat-app

## Overview

##### Project Type and Purpose
- This is a full-stack, real-time chat/messaging application.
- Frontend: React with Vite, Tailwind CSS, HMR.
- Backend: Node.js + Express, MongoDB, JWT-based auth.
- Key features: user signup/login, protected routes, conversations, messages.

##### File Structure
- Top-level:
- server.js – Express app entry point
- db/connectMongoDB.js – MongoDB connection
- models/, controllers/, routes/, middleware/ – classic MVC on backend
- utils/generateToken.js – JWT generation
- public/index.html – single-page app host
- Frontend under src/:
- src/main.jsx, src/App.jsx – React app entry
- src/components/… – UI primitives: Sidebar, Conversations, Messages
- src/context/AuthContext.jsx – auth state via React Context
- src/hooks/useLogin.js, useSignup.js, useLogout.js – encapsulate API calls
- Config: Vite, ESLint, PostCSS, Tailwind.

##### README Insights
- Boilerplate README, but you know the stack from structure:
React + Vite + Express + Mongo.

a. Main Components:
- Client (Browser): React SPA
- API Layer (Express server)
- Database (MongoDB)
- External services: (optional) Hosting / CDN
b. Relationships & Data Flow:
1. User interacts with React UI →
2. React Context + Hooks call REST endpoints (/auth, /message, /user) →
3. Express routes invoke middleware (e.g., protectRoute) →
4. Controller handles logic → calls Mongoose models →
5. MongoDB stores/fetches users, conversations, messages →
6. Controller returns JSON →
7. Frontend updates UI in real time.
c. Key Architectural Patterns:
- Backend: MVC (routes → controllers → models)
- Auth: JWT token in HTTP headers, protectRoute middleware
- Frontend: Unidirectional data flow, React Context for global auth, custom hooks for API.
d. Technologies/Frameworks:
- Frontend: React, Vite, Tailwind CSS, ESLint, PostCSS
- Backend: Node.js, Express, Mongoose, MongoDB, JSON Web Token

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend Layer"
        direction TB
        Main["React SPA (src/main.jsx)"]:::frontend
        App["App Component (src/App.jsx)"]:::frontend
        subgraph "Pages"
            direction TB
            Home["Home Page (src/pages/home/Home.jsx)"]:::frontend
            LoginPage["Login Page (src/pages/login/Login.jsx)"]:::frontend
            SignupPage["Signup Page (src/pages/signup/SignUp.jsx)"]:::frontend
            GenderCheckbox["Gender Checkbox (src/pages/signup/GenderCheckbox.jsx)"]:::frontend
        end
        subgraph "Components"
            direction TB
            Sidebar["Sidebar (src/components/sidebar/Sidebar.jsx)"]:::frontend
            ConversationsList["Conversations (src/components/sidebar/Conversations.jsx)"]:::frontend
            ConversationItem["Conversation (src/components/sidebar/Conversation.jsx)"]:::frontend
            LogoutButton["Logout Button (src/components/sidebar/LogoutButton.jsx)"]:::frontend
            SearchInput["Search Input (src/components/sidebar/SearchInput.jsx)"]:::frontend
            MessagesList["Messages List (src/components/messages/Messages.jsx)"]:::frontend
            MessageContainer["Message Container (src/components/messages/MessageContainer.jsx)"]:::frontend
            MessageItem["Message (src/components/messages/Message.jsx)"]:::frontend
            MessageInput["Message Input (src/components/messages/MessageInput.jsx)"]:::frontend
        end
        subgraph "Hooks & Context"
            direction TB
            AuthContext["Auth Context (src/context/AuthContext.jsx)"]:::frontend
            useLogin["useLogin (src/hooks/useLogin.js)"]:::frontend
            useSignup["useSignup (src/hooks/useSignup.js)"]:::frontend
            useLogout["useLogout (src/hooks/useLogout.js)"]:::frontend
        end
    end

    %% API Layer
    subgraph "API Layer"
        direction TB
        Server["Express Server (server.js)"]:::backend
        subgraph "Routes"
            direction TB
            AuthRoutes["Auth Routes (routes/auth.routes.js)"]:::backend
            UserRoutes["User Routes (routes/user.routes.js)"]:::backend
            MessageRoutes["Message Routes (routes/message.routes.js)"]:::backend
        end
        Protect["Auth Middleware (middleware/protectRoute.js)"]:::backend
        subgraph "Controllers"
            direction TB
            AuthController["Auth Controller (controllers/auth.controller.js)"]:::backend
            UserController["User Controller (controllers/user.controller.js)"]:::backend
            MessageController["Message Controller (controllers/message.controller.js)"]:::backend
        end
        Utils["JWT Utility (utils/generateToken.js)"]:::backend
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        MongoConn["MongoDB Connection (db/connectMongoDB.js)"]:::backend
        DB["MongoDB Cluster"]:::database
        subgraph "Models"
            direction TB
            UserModel["User Model (models/user.model.js)"]:::database
            ConversationModel["Conversation Model (models/conversation.model.js)"]:::database
            MessageModel["Message Model (models/message.model.js)"]:::database
        end
    end

    %% Connections
    Main -->|boots App| App
    App -->|renders Pages| Home
    App -->|renders Pages| LoginPage
    App -->|renders Pages| SignupPage
    SignupPage -->|uses| GenderCheckbox
    App -->|renders| Sidebar
    Sidebar -->|contains| ConversationsList
    ConversationsList -->|item| ConversationItem
    Sidebar -->|contains| LogoutButton
    Sidebar -->|contains| SearchInput
    App -->|renders| MessagesList
    MessagesList -->|wraps| MessageContainer
    MessageContainer -->|shows| MessageItem
    App -->|renders| MessageInput
    App -->|provides| AuthContext
    AuthContext -->|uses| useLogin
    AuthContext -->|uses| useSignup
    AuthContext -->|uses| useLogout

    App -->|HTTP/HTTPS| Server
    useLogin -->|POST /login| Server
    useSignup -->|POST /signup| Server
    useLogout -->|POST /logout| Server
    Server -->|routes to| AuthRoutes
    Server -->|routes to| UserRoutes
    Server -->|routes to| MessageRoutes
    AuthRoutes -->|protectRoute| Protect
    UserRoutes -->|protectRoute| Protect
    MessageRoutes -->|protectRoute| Protect
    AuthRoutes -->|calls| AuthController
    UserRoutes -->|calls| UserController
    MessageRoutes -->|calls| MessageController
    AuthController -->|uses| Utils
    AuthController -->|uses| UserModel
    UserController -->|uses| UserModel
    MessageController -->|uses| ConversationModel
    MessageController -->|uses| MessageModel

    AuthController -->|connects| MongoConn
    UserController -->|connects| MongoConn
    MessageController -->|connects| MongoConn
    MongoConn -->|connects to| DB

    %% Click Events
    click Main "https://github.com/yashu1113/real-time-chat-app/blob/main/src/main.jsx"
    click App "https://github.com/yashu1113/real-time-chat-app/blob/main/src/App.jsx"
    click Sidebar "https://github.com/yashu1113/real-time-chat-app/blob/main/src/components/sidebar/Sidebar.jsx"
    click ConversationsList "https://github.com/yashu1113/real-time-chat-app/blob/main/src/components/sidebar/Conversations.jsx"
    click ConversationItem "https://github.com/yashu1113/real-time-chat-app/blob/main/src/components/sidebar/Conversation.jsx"
    click LogoutButton "https://github.com/yashu1113/real-time-chat-app/blob/main/src/components/sidebar/LogoutButton.jsx"
    click SearchInput "https://github.com/yashu1113/real-time-chat-app/blob/main/src/components/sidebar/SearchInput.jsx"
    click MessagesList "https://github.com/yashu1113/real-time-chat-app/blob/main/src/components/messages/Messages.jsx"
    click MessageContainer "https://github.com/yashu1113/real-time-chat-app/blob/main/src/components/messages/MessageContainer.jsx"
    click MessageItem "https://github.com/yashu1113/real-time-chat-app/blob/main/src/components/messages/Message.jsx"
    click MessageInput "https://github.com/yashu1113/real-time-chat-app/blob/main/src/components/messages/MessageInput.jsx"
    click AuthContext "https://github.com/yashu1113/real-time-chat-app/blob/main/src/context/AuthContext.jsx"
    click useLogin "https://github.com/yashu1113/real-time-chat-app/blob/main/src/hooks/useLogin.js"
    click useSignup "https://github.com/yashu1113/real-time-chat-app/blob/main/src/hooks/useSignup.js"
    click useLogout "https://github.com/yashu1113/real-time-chat-app/blob/main/src/hooks/useLogout.js"
    click Home "https://github.com/yashu1113/real-time-chat-app/blob/main/src/pages/home/Home.jsx"
    click LoginPage "https://github.com/yashu1113/real-time-chat-app/blob/main/src/pages/login/Login.jsx"
    click SignupPage "https://github.com/yashu1113/real-time-chat-app/blob/main/src/pages/signup/SignUp.jsx"
    click GenderCheckbox "https://github.com/yashu1113/real-time-chat-app/blob/main/src/pages/signup/GenderCheckbox.jsx"
    click Server "https://github.com/yashu1113/real-time-chat-app/blob/main/server.js"
    click MongoConn "https://github.com/yashu1113/real-time-chat-app/blob/main/db/connectMongoDB.js"
    click UserModel "https://github.com/yashu1113/real-time-chat-app/blob/main/models/user.model.js"
    click ConversationModel "https://github.com/yashu1113/real-time-chat-app/blob/main/models/conversation.model.js"
    click MessageModel "https://github.com/yashu1113/real-time-chat-app/blob/main/models/message.model.js"
    click AuthController "https://github.com/yashu1113/real-time-chat-app/blob/main/controllers/auth.controller.js"
    click UserController "https://github.com/yashu1113/real-time-chat-app/blob/main/controllers/user.controller.js"
    click MessageController "https://github.com/yashu1113/real-time-chat-app/blob/main/controllers/message.controller.js"
    click AuthRoutes "https://github.com/yashu1113/real-time-chat-app/blob/main/routes/auth.routes.js"
    click UserRoutes "https://github.com/yashu1113/real-time-chat-app/blob/main/routes/user.routes.js"
    click MessageRoutes "https://github.com/yashu1113/real-time-chat-app/blob/main/routes/message.routes.js"
    click Protect "https://github.com/yashu1113/real-time-chat-app/blob/main/middleware/protectRoute.js"
    click Utils "https://github.com/yashu1113/real-time-chat-app/blob/main/utils/generateToken.js"

    %% Styles
    classDef frontend fill:#D6E4FF,stroke:#333,stroke-width:1px
    classDef backend fill:#D2F8D2,stroke:#333,stroke-width:1px
    classDef database fill:#FFE4B3,stroke:#333,stroke-width:1px
```
