# parthib007/miro_whiteboard architecture

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

- Interactive diagram: https://gitdiagram.com/parthib007/miro_whiteboard
- Repository: https://github.com/parthib007/miro_whiteboard

## Overview

##### Project type and purpose
- This is a full-stack web application that provides a real-time collaborative whiteboard.
- Frontend: React + Next.js for server-side rendering and static export.
- Backend: Node.js + Express, using Socket.IO for real-time communication.
- Database: MongoDB for persisting sessions, drawings, chat messages, user profiles.
- Authentication: JWT and OAuth for user login and role management.

##### File structure
- Top-level “pages” and “modules” directories contain all the Next.js pages and feature modules (home page, room page, chat, drawing board, toolbar, etc.).
- “common” directory holds shared utilities, components (modal, portal), styles, hooks, recoil state atoms/selectors, and socket helper.
- “server/index.ts” is the custom Express + Socket.IO server that sets up HTTP, WebSocket endpoints, and connects to MongoDB.
- Configuration files: next.config.js, tsconfig.json, tailwind.config.js, postcss.config.js, linter configs.
- Build artifacts in “.next” and “build” show the two deployment modes: Next.js SSR/static output and compiled server code.

##### README for additional insights
- Features list confirms real-time collaboration, drawing tools, chat, image upload, save/load, export, integrations.
- Scripts show separate build pipelines: “build:server” compiles server, “build:next” builds Next.js, “start” launches production server.

a. Main components
- Browser / Client (User’s web browser)
- Next.js server (handles SSR, static asset serve, REST API routes if any)
- Express + Socket.IO server (real-time event broker)
- MongoDB database
- External Auth providers (OAuth services: Google, GitHub, Slack)
- (Optional) CDN for static assets and image hosting

b. Relationships & interactions
- Browser ←HTTP(S)→ Next.js server for initial page render, static assets, REST API calls (e.g., fetch saved sessions).
- Browser ↔WebSocket (Socket.IO)↔ Express server for real-time drawing events, chat messages, user presence.
- Express server ↔MongoDB for persisting drawing data, chat logs, session metadata.
- Next.js server ↔Express server may share auth middleware or proxy socket connections.
- Browser ↔OAuth provider for login flows (redirect → callback).

c. Architectural patterns & design principles
- Separation of concerns:
- Presentation layer (Next.js + React modules)
- Application layer (Express controllers, Socket.IO event handlers)
- Persistence layer (MongoDB)
- Publish-subscribe pattern (Socket.IO rooms for separate whiteboard sessions).
- Modular frontend structure (feature modules under “modules/room”, “modules/home”; shared code in “common”).
- State management with Recoil for local UI state; server sync via WebSocket.

d. Key technologies & frameworks
- Frontend: Next.js, React, Recoil, Tailwind CSS
- Real-time: Socket.IO
- Backend: Node.js, Express
- DB: MongoDB (Mongoose or native driver)
- Auth: JWT, OAuth2 flows
- Build & Deploy: ts-node, nodemon, GitHub Pages (static export), custom server for production

## Diagram (Mermaid)

```mermaid
flowchart TB
  %% Client Layer
  subgraph "Client (Browser)"
    direction TB
    subgraph "UI Components" 
      direction TB
      HomePage["HomePage"]:::frontend
      RoomPage["RoomPage"]:::frontend
      ChatFeature["Chat Feature"]:::frontend
      DrawingBoard["Drawing Board"]:::frontend
      Toolbar["Toolbar & Tools"]:::frontend
    end
    subgraph "State Management (Recoil)"
      direction TB
      RecoilAtoms["Room, Moves, Options, Modal, Background Atoms"]:::frontend
      RecoilHooks["Recoil Hooks"]:::frontend
    end
    subgraph "Common Library"
      direction TB
      ModalManager["Modal Manager"]:::frontend
      Portal["Portal"]:::frontend
      Constants["Constants"]:::frontend
      Hooks["useViewportSize Hook"]:::frontend
      SocketClient["Socket.IO Client"]:::frontend
      Styles["Global Styles"]:::frontend
      Types["Global Types"]:::frontend
    end
  end

  %% Server Layer
  subgraph "Server"
    direction TB
    NextServer["Next.js SSR & Static"]:::backend
    ExpressServer["Express + Socket.IO"]:::backend
    MongoDB["MongoDB"]:::database
    OAuth["OAuth Providers"]:::external
    CDN["CDN / Static Assets"]:::external
  end

  %% Interactions
  HomePage -->|"HTTP GET /"| NextServer
  RoomPage -->|"HTTP GET /[roomId]"| NextServer
  HomePage -->|"WS connect"| ExpressServer
  RoomPage -->|"WS connect"| ExpressServer
  ChatFeature -->|"send/receive messages"| ExpressServer
  DrawingBoard -->|"draw events"| ExpressServer
  Toolbar -->|"tool updates"| ExpressServer
  RecoilHooks -->|"state sync"| ExpressServer
  SocketClient -->|"ws://"/| ExpressServer
  NextServer -->|"proxy ws"| ExpressServer
  ExpressServer -->|"read/write"| MongoDB
  NextServer -->|"REST API"| MongoDB
  HomePage -->|"OAuth redirect/callback"| OAuth
  NextServer -->|"serve assets"| CDN

  %% Click Events - Frontend
  click HomePage "https://github.com/parthib007/miro_whiteboard/blob/main/pages/index.tsx"
  click RoomPage "https://github.com/parthib007/miro_whiteboard/blob/main/pages/[roomId].tsx"
  click HomePage "https://github.com/parthib007/miro_whiteboard/blob/main/pages/_app.tsx"
  click HomePage "https://github.com/parthib007/miro_whiteboard/blob/main/pages/_document.tsx"
  click HomePage "https://github.com/parthib007/miro_whiteboard/blob/main/next.config.js"
  click ModalManager "https://github.com/parthib007/miro_whiteboard/blob/main/common/components/modal/components/ModalManager.tsx"
  click Portal "https://github.com/parthib007/miro_whiteboard/blob/main/common/components/portal/components/Portal.ts"
  click Constants "https://github.com/parthib007/miro_whiteboard/blob/main/common/constants/canvasSize.ts"
  click Hooks "https://github.com/parthib007/miro_whiteboard/blob/main/common/hooks/useViewportSize.ts"
  click SocketClient "https://github.com/parthib007/miro_whiteboard/blob/main/common/lib/socket.ts"
  click Styles "https://github.com/parthib007/miro_whiteboard/blob/main/common/styles/global.css"
  click Types "https://github.com/parthib007/miro_whiteboard/blob/main/common/types/global.d.ts"
  click RecoilAtoms "https://github.com/parthib007/miro_whiteboard/blob/main/common/recoil/room/room.atom.ts"
  click RecoilAtoms "https://github.com/parthib007/miro_whiteboard/blob/main/common/recoil/savedMoves/savedMoves.atom.ts"
  click RecoilAtoms "https://github.com/parthib007/miro_whiteboard/blob/main/common/recoil/options/options.atom.ts"
  click RecoilAtoms "https://github.com/parthib007/miro_whiteboard/blob/main/common/recoil/modal/modal.atom.tsx"
  click RecoilAtoms "https://github.com/parthib007/miro_whiteboard/blob/main/common/recoil/background/background.atom.ts"
  click RecoilHooks "https://github.com/parthib007/miro_whiteboard/blob/main/common/recoil/room/room.hooks.ts"
  click RecoilHooks "https://github.com/parthib007/miro_whiteboard/blob/main/common/recoil/savedMoves/savedMoves.hooks.ts"
  click RecoilHooks "https://github.com/parthib007/miro_whiteboard/blob/main/common/recoil/options/options.hooks.ts"
  click RecoilHooks "https://github.com/parthib007/miro_whiteboard/blob/main/common/recoil/modal/modal.hooks.tsx"
  click RecoilHooks "https://github.com/parthib007/miro_whiteboard/blob/main/common/recoil/background/background.hooks.ts"
  click NextServer "https://github.com/parthib007/miro_whiteboard/blob/main/pages/_app.tsx"
  click NextServer "https://github.com/parthib007/miro_whiteboard/blob/main/pages/_document.tsx"
  click NextServer "https://github.com/parthib007/miro_whiteboard/blob/main/next.config.js"

  %% Click Events - Home & Room components
  click HomePage "https://github.com/parthib007/miro_whiteboard/blob/main/modules/home/components/Home.tsx"
  click HomePage "https://github.com/parthib007/miro_whiteboard/blob/main/modules/home/modals/NotFound.tsx"
  click RoomPage "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/Room.tsx"
  click RoomPage "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/context/Room.context.tsx"

  %% Click Events - Drawing Board Components
  click DrawingBoard "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/board/Canvas.tsx"
  click DrawingBoard "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/board/Background.tsx"
  click DrawingBoard "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/board/Minimap.tsx"
  click DrawingBoard "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/board/MousePosition.tsx"
  click DrawingBoard "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/board/MousesRenderer.tsx"
  click DrawingBoard "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/board/MoveImage.tsx"
  click DrawingBoard "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/board/SelectionBtns.tsx"
  click DrawingBoard "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/board/UserMouse.tsx"

  %% Click Events - Chat Components
  click ChatFeature "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/chat/Chat.tsx"
  click ChatFeature "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/chat/ChatInput.tsx"
  click ChatFeature "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/chat/Message.tsx"

  %% Click Events - Toolbar Components
  click Toolbar "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/toolbar/ToolBar.tsx"
  click Toolbar "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/toolbar/BackgoundPicker.tsx"
  click Toolbar "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/toolbar/ColorPicker.tsx"
  click Toolbar "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/toolbar/HistoryBtns.tsx"
  click Toolbar "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/toolbar/ImagePicker.tsx"
  click Toolbar "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/toolbar/LineWidthPicker.tsx"
  click Toolbar "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/toolbar/ModePicker.tsx"
  click Toolbar "https://github.com/parthib007/miro_whiteboard/blob/main/modules/room/components/toolbar/ShapeSelector.tsx"

  %% Click Events - Server & Build
  click ExpressServer "https://github.com/parthib007/miro_whiteboard/blob/main/server/index.ts"
  click MongoDB "https://github.com/parthib007/miro_whiteboard/blob/main/server/index.ts"
  click ExpressServer "https://github.com/parthib007/miro_whiteboard/blob/main/build/index.js"
  click ExpressServer "https://github.com/parthib007/miro_whiteboard/blob/main/tsconfig.server.json"

  %% Styles
  classDef frontend fill:#D0E6FF,stroke:#0366d6,color:#000
  classDef backend fill:#C8F8C8,stroke:#228B22,color:#000
  classDef database fill:#FFD8B0,stroke:#D2691E,color:#000
  classDef external fill:#FFE4E1,stroke:#A52A2A,color:#000
```
