# thearnabsaha/chat-app architecture

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

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

## Overview

##### Project type and purpose
- This is a full-stack real-time chat application organized in a monorepo (pnpm + Turborepo).
- It consists of three main runnable apps—Next.js web client, Express REST API server, and a WebSockets server—plus shared packages for common types, database access (Prisma), UI components, and lint/TypeScript configs.

##### File structure
- Top-level “apps” directory with:
- express-server (src/controllers, routes, JWT middleware, config)
- websockets-server (entrypoint only)
- web (Next.js 13 app directory, components, hooks, Tailwind, Zustand stores)
- “packages” directory with:
- common (shared types)
- backend-common (shared utilities for servers)
- db (Prisma schema & migrations + client wrapper)
- ui (shared React/Tailwind components)
- eslint-config & typescript-config (shared lint/build configs)
- Root configs (turbo.json, tsconfig.json, pnpm-workspace.yaml) orchestrate workspace builds.

##### README for additional insights
- REST API routes for Users (`/signup`, `/signin`, `/me`, `/health`), Chats (`/chat` CRUD), Rooms (`/room` CRUD).
- JWT-protected endpoints.
- Controllers implement business logic, Prisma is used under the hood for persistence.

- Web Client (Next.js app)
- REST API Service (Express)
- WebSockets Service
- Database (PostgreSQL via Prisma)
- Shared Package Modules (common, backend-common, db, ui)
- External Auth (JWT token issuance & validation)
b. Relationships and data flows:
1. User ↔ Web Client (browser)
2. Web Client ↔ REST API (HTTP/JSON + Authorization: Bearer JWT)
3. REST API ↔ Database (Prisma Client)
4. Web Client ↔ WebSockets Server (real-time messaging)
5. WebSockets Server ↔ Database (optional writes/reads via Prisma)
6. Both server apps import shared packages (common types, db wrappers, backend utilities) from workspace
c. Architectural patterns & design principles:
- Monorepo with code-sharing via local packages
- Separation of concerns: UI vs. business logic vs. real-time messaging
- Modular controllers/routes/middleware in Express
- Component-driven design in Next.js + shared UI library
- Strong typing & validation (TypeScript + shared types)
d. Key technologies / frameworks / libraries:
- Next.js 13 (app router, React, Tailwind CSS, Zustand stores)
- Express.js + TypeScript + JWT middleware
- ws or socket.io (WebSockets server)
- Prisma ORM + PostgreSQL (migrations in packages/db)
- pnpm / Turborepo (monorepo tooling)
- Shared UI components (packages/ui) and shared configs

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Tier
    User(("User (Browser)")):::frontend
    subgraph "Web Client" 
        direction TB
        WebClient["Next.js Web Client"]:::frontend
        WC_app["/app"]:::frontend
        WC_components["/components"]:::frontend
        WC_hooks["UseWebsockets.ts"]:::frontend
        WC_store["/lib/store"]:::frontend
        WC_config["config.ts"]:::frontend
    end

    %% Application Tier
    subgraph "Express REST API"
        direction TB
        API["Express REST API"]:::backend
        API_index["index.ts"]:::backend
        API_controllers["controllers"]:::backend
        API_routes["routes"]:::backend
        API_jwt["jwtAuth.ts"]:::backend
        API_config["config.ts"]:::backend
    end

    subgraph "WebSockets Server"
        direction TB
        WS["WebSockets Server"]:::backend
        WS_index["index.ts"]:::backend
    end

    %% Data Tier
    Database[(PostgreSQL<br/>Prisma)]:::db

    %% Shared Packages
    subgraph "Shared Packages"
        direction TB
        common["common"]:::shared
        common_types["types.ts"]:::shared
        backendCommon["backend-common"]:::shared
        dbPkg["db"]:::shared
        db_schema["schema.prisma"]:::shared
        db_migrations["migrations"]:::shared
        db_index["index.ts"]:::shared
        uiPkg["ui"]:::shared
        ui_components["components"]:::shared
        ui_styles["globals.css"]:::shared
        eslintCfg["eslint-config"]:::shared
        eslint_base["base.js"]:::shared
        eslint_next["next.js"]:::shared
        eslint_react["react-internal.js"]:::shared
        tsConfig["typescript-config"]:::shared
        ts_base["base.json"]:::shared
        ts_nextjs["nextjs.json"]:::shared
        ts_reactlib["react-library.json"]:::shared
    end

    %% Connections
    User --> WebClient
    WebClient -->|"HTTP/JSON + Bearer JWT"| API
    WebClient -->|"WSS"| WS
    API -->|"Prisma Client"| Database
    WS -->|"Prisma Client"| Database

    common --> WebClient
    uiPkg --> WebClient

    common --> API
    backendCommon --> API
    dbPkg --> API

    common --> WS
    backendCommon --> WS
    dbPkg --> WS

    %% Click Events - Web Client
    click WebClient "https://github.com/thearnabsaha/chat-app/tree/main/apps/web"
    click WC_app "https://github.com/thearnabsaha/chat-app/tree/main/apps/web/app"
    click WC_components "https://github.com/thearnabsaha/chat-app/tree/main/apps/web/components"
    click WC_hooks "https://github.com/thearnabsaha/chat-app/blob/main/apps/web/hooks/UseWebsockets.ts"
    click WC_store "https://github.com/thearnabsaha/chat-app/tree/main/apps/web/lib/store"
    click WC_config "https://github.com/thearnabsaha/chat-app/blob/main/apps/web/lib/config.ts"

    %% Click Events - Express REST API
    click API "https://github.com/thearnabsaha/chat-app/tree/main/apps/express-server"
    click API_index "https://github.com/thearnabsaha/chat-app/blob/main/apps/express-server/src/index.ts"
    click API_controllers "https://github.com/thearnabsaha/chat-app/tree/main/apps/express-server/src/controllers"
    click API_routes "https://github.com/thearnabsaha/chat-app/tree/main/apps/express-server/src/routes"
    click API_jwt "https://github.com/thearnabsaha/chat-app/blob/main/apps/express-server/src/middlewares/jwtAuth.ts"
    click API_config "https://github.com/thearnabsaha/chat-app/blob/main/apps/express-server/src/utils/config.ts"

    %% Click Events - WebSockets Server
    click WS "https://github.com/thearnabsaha/chat-app/tree/main/apps/websockets-server"
    click WS_index "https://github.com/thearnabsaha/chat-app/blob/main/apps/websockets-server/src/index.ts"

    %% Click Events - Shared Packages
    click common "https://github.com/thearnabsaha/chat-app/tree/main/packages/common"
    click common_types "https://github.com/thearnabsaha/chat-app/blob/main/packages/common/src/types.ts"
    click backendCommon "https://github.com/thearnabsaha/chat-app/tree/main/packages/backend-common"
    click dbPkg "https://github.com/thearnabsaha/chat-app/tree/main/packages/db"
    click db_schema "https://github.com/thearnabsaha/chat-app/blob/main/packages/db/prisma/schema.prisma"
    click db_migrations "https://github.com/thearnabsaha/chat-app/tree/main/packages/db/prisma/migrations"
    click db_index "https://github.com/thearnabsaha/chat-app/blob/main/packages/db/src/index.ts"
    click uiPkg "https://github.com/thearnabsaha/chat-app/tree/main/packages/ui"
    click ui_components "https://github.com/thearnabsaha/chat-app/tree/main/packages/ui/src/components"
    click ui_styles "https://github.com/thearnabsaha/chat-app/blob/main/packages/ui/src/styles/globals.css"
    click eslintCfg "https://github.com/thearnabsaha/chat-app/tree/main/packages/eslint-config"
    click eslint_base "https://github.com/thearnabsaha/chat-app/blob/main/packages/eslint-config/base.js"
    click eslint_next "https://github.com/thearnabsaha/chat-app/blob/main/packages/eslint-config/next.js"
    click eslint_react "https://github.com/thearnabsaha/chat-app/blob/main/packages/eslint-config/react-internal.js"
    click tsConfig "https://github.com/thearnabsaha/chat-app/tree/main/packages/typescript-config"
    click ts_base "https://github.com/thearnabsaha/chat-app/blob/main/packages/typescript-config/base.json"
    click ts_nextjs "https://github.com/thearnabsaha/chat-app/blob/main/packages/typescript-config/nextjs.json"
    click ts_reactlib "https://github.com/thearnabsaha/chat-app/blob/main/packages/typescript-config/react-library.json"

    %% Styles
    classDef frontend fill:#cdefff,stroke:#2b62d9,stroke-width:1px;
    classDef backend fill:#c8e6c9,stroke:#2b7d32,stroke-width:1px;
    classDef db fill:#ffe0b2,stroke:#fb8c00,stroke-width:1px;
    classDef shared fill:#e0e0e0,stroke:#616161,stroke-width:1px;
```
