# nasimreja077/barta-lap-chatapp architecture

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

- Interactive diagram: https://gitdiagram.com/nasimreja077/barta-lap-chatapp
- Repository: https://github.com/nasimreja077/barta-lap-chatapp

## Overview

##### Project Type and Purpose
- This is a full-stack, real-time chat application (“Barta Lap”) composed of two primary parts:
- A backend service (Node.js, Express, MongoDB, Socket.IO, Cloudinary)
- A frontend Single-Page App (React + Vite, Tailwind CSS, Zustand, Socket.IO-client)
- Purpose: Enable users to sign up, authenticate, send/receive text messages and images in real time, manage profile/settings, with media storage in Cloudinary.

##### File Structure and Architectural Patterns
- Top-level “backend” and “frontend” directories → clear separation of concerns.
- Backend follows MVC + service layering:
- src/controllers (auth, messages)
- src/models (Mongoose schemas for User, Message)
- src/routes (Express routers)
- src/lib (DB connection, Cloudinary integration, Socket setup, utilities)
- src/middleware (authentication guard)
- Frontend is component-driven React SPA using Vite:
- src/pages (route-level pages: Home, Login, SignUp, Profile, Settings)
- src/components (UI pieces: ChatContainer, Sidebar, Navbar, skeleton loaders)
- src/store (Zustand stores for auth, chat, theme)
- src/lib (Axios wrapper, Socket.IO client, utils)
- Real-time communication: Socket.IO on both client and server.
- Persistence: MongoDB (hosted externally, connection via env).
- Media: Cloudinary used for image uploads.

a. Client Browser / React SPA
b. HTTP API Server (Express)
c. WebSocket Server (Socket.IO) – co-located with HTTP server
d. MongoDB Database
e. Cloudinary Media Service
f. Authentication (JWT via auth.middleware)
g. Static Assets (served by Vite dev server or via production build)

##### Relationships & Data Flow
- User interacts with React UI → Axios HTTP calls to /auth (signup/login) and REST endpoints (/messages)
- On login/signup, JWT returned → stored in client store → used in Authorization header
- For real-time messaging: client opens Socket.IO connection (with JWT) → server authenticates via middleware → join user room
- Send message: client emits “send_message” → server controller writes to MongoDB → broadcasts via Socket.IO to recipient
- Media uploads: client posts image file to Express endpoint → Express uses Cloudinary SDK → returns URL → included in message payload
- Server seeds initial data via user.seed.js if needed (dev).

##### Architectural Patterns & Principles
- MVC on backend: controllers handle HTTP, delegate to models
- Layered architecture: controllers → services (lib utils) → persistence
- Component-based frontend: pages, components, central stores
- Separation of concerns: UI, state, network, real-time events
- Single source of truth: Zustand stores for auth/chat/theme

##### Detailed Component Breakdown (optional inset)
- Frontend:
- Pages (Home, Login, SignUp, Profile, Settings)
- Core Components (Navbar, Sidebar, ChatContainer, MessageInput)
- Store Layer (useAuthStore, useChatStore)
- Network Layer (Axios client, Socket client)
- Backend:
- Routes (/auth, /messages)
- Controllers (auth.controller.js, message.controller.js)
- Middleware (auth.middleware.js)
- Models (user.model.js, message.model.js)
- Lib Utilities (db.js, socket.js, cloudinary.js)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Frontend Tier
    subgraph "Frontend (React SPA)"
        direction TB
        ReactSPA["React SPA"]:::frontend
        subgraph "Pages"
            direction TB
            HomePage["HomePage"]:::frontend
            LoginPage["LoginPage"]:::frontend
            SignUpPage["SignUpPage"]:::frontend
            ProfilePage["ProfilePage"]:::frontend
            SettingsPage["SettingsPage"]:::frontend
        end
        subgraph "Components"
            direction TB
            ChatContainer["ChatContainer"]:::frontend
            Sidebar["Sidebar"]:::frontend
            Navbar["Navbar"]:::frontend
            MessageInput["MessageInput"]:::frontend
            ChatHeader["ChatHeader"]:::frontend
            NoChatSelected["NoChatSelected"]:::frontend
            AuthImagePattern["AuthImagePattern"]:::frontend
            MessageSkeleton["MessageSkeleton"]:::frontend
            SidebarSkeleton["SidebarSkeleton"]:::frontend
        end
        subgraph "Stores"
            direction TB
            AuthStore["useAuthStore"]:::frontend
            ChatStore["useChatStore"]:::frontend
            ThemeStore["useThemeStore"]:::frontend
        end
        subgraph "Lib & Network"
            direction TB
            AxiosClient["Axios HTTP Client"]:::frontend
            SocketClient["Socket.IO Client"]:::frontend
            UtilsFE["Utils"]:::frontend
        end
    end

    %% Backend Tier
    subgraph "Backend (Express API & Socket.IO)"
        direction TB
        APIServer["Express API Server"]:::backend
        WS["Socket.IO Server"]:::backend
        subgraph "Routes"
            direction TB
            AuthRoute["/auth Routes"]:::backend
            MessageRoute["/messages Routes"]:::backend
        end
        subgraph "Controllers"
            direction TB
            AuthController["AuthController"]:::backend
            MessageController["MessageController"]:::backend
        end
        subgraph "Middleware"
            direction TB
            AuthMiddleware["auth.middleware"]:::backend
        end
        subgraph "Models"
            direction TB
            UserModel["UserModel"]:::backend
            MessageModel["MessageModel"]:::backend
        end
        subgraph "Lib & Services"
            direction TB
            DBConn["DB Connection"]:::backend
            SocketSetup["Socket Setup"]:::backend
            Cloudinary["Cloudinary Integration"]:::external
            UtilsBE["Utils"]:::backend
        end
        SeedScript["User Seed Script"]:::backend
        EnvConfig[".env Sample"]:::backend
    end

    %% External Services
    MongoDB["MongoDB Atlas"]:::external
    CloudinarySvc["Cloudinary Service"]:::external

    %% Connections - Frontend to Backend
    ReactSPA -->|"HTTPS 443 REST"| AxiosClient
    AxiosClient -->|"POST /auth/login, signup"| AuthRoute
    AxiosClient -->|"GET/POST /messages"| MessageRoute

    %% Auth Flow
    AuthRoute -->|"calls"| AuthController
    AuthController -->|"reads/writes"| UserModel
    UserModel -->|"connect"| DBConn
    DBConn --> MongoDB

    %% Message REST Flow
    MessageRoute -->|"calls"| MessageController
    MessageController -->|"writes"| MessageModel
    MessageModel -->|"connect"| DBConn

    %% Real-time Flow
    ReactSPA -->|"WS w/ JWT"| SocketClient
    SocketClient <-->|"WS 3000"| WS
    WS -->|"authenticate via auth.middleware"| AuthMiddleware
    WS -->|"on send_message"| MessageController
    MessageController -->|"writes"| MessageModel
    MessageModel --> DBConn
    WS -->|"broadcast"| SocketClient

    %% Media Upload Flow
    ReactSPA -->|"HTTP POST image"| MessageRoute
    MessageRoute -->|"uses"| Cloudinary
    Cloudinary --> CloudinarySvc
    CloudinarySvc -->|"URL"| MessageController
    MessageController --> MessageModel

    %% Seed & Env
    SeedScript --> DBConn
    EnvConfig --> DBConn
    EnvConfig --> Cloudinary

    %% Click Events - Frontend
    click ReactSPA "https://github.com/nasimreja077/barta-lap-chatapp/tree/main/frontend/src"
    click HomePage "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/pages/HomePage.jsx"
    click LoginPage "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/pages/LoginPage.jsx"
    click SignUpPage "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/pages/SignUpPage.jsx"
    click ProfilePage "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/pages/ProfilePage.jsx"
    click SettingsPage "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/pages/SettingsPage.jsx"
    click ChatContainer "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/components/ChatContainer.jsx"
    click Sidebar "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/components/Sidebar.jsx"
    click Navbar "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/components/Navbar.jsx"
    click MessageInput "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/components/MessageInput.jsx"
    click ChatHeader "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/components/ChatHeader.jsx"
    click NoChatSelected "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/components/NoChatSelected.jsx"
    click AuthImagePattern "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/components/AuthImagePattern.jsx"
    click MessageSkeleton "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/components/skeletons/MessageSkeleton.jsx"
    click SidebarSkeleton "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/components/skeletons/SidebarSkeleton.jsx"
    click AuthStore "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/store/useAuthStore.js"
    click ChatStore "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/store/useChatStore.js"
    click ThemeStore "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/store/useThemeStore.js"
    click AxiosClient "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/lib/axios.js"
    click SocketClient "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/lib/socket.js"
    click UtilsFE "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/lib/utils.js"
    click ReactSPA "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/main.jsx"
    click ReactSPA "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/src/App.jsx"
    click ReactSPA "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/index.html"
    click ReactSPA "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/frontend/vite.config.js"

    %% Click Events - Backend
    click APIServer "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/index.js"
    click AuthRoute "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/routes/auth.route.js"
    click MessageRoute "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/routes/message.route.js"
    click AuthController "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/controllers/auth.controller.js"
    click MessageController "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/controllers/message.controller.js"
    click AuthMiddleware "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/middleware/auth.middleware.js"
    click UserModel "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/models/user.model.js"
    click MessageModel "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/models/message.model.js"
    click DBConn "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/lib/db.js"
    click SocketSetup "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/lib/socket.js"
    click Cloudinary "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/lib/cloudinary.js"
    click UtilsBE "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/lib/utils.js"
    click SeedScript "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/src/seeds/user.seed.js"
    click EnvConfig "https://github.com/nasimreja077/barta-lap-chatapp/blob/main/backend/.env.sample"

    %% Classes
    classDef frontend fill:#D0E8FF,stroke:#0366D6,color:#0366D6;
    classDef backend fill:#DFFFE0,stroke:#22863A,color:#22863A;
    classDef external fill:#FFF5B1,stroke:#DBAB09,color:#735C0F;
```
