# vaibhavdevelopor/real-time-collaborative-code-editor architecture

> Architecture diagram of the GitHub repository vaibhavdevelopor/real-time-collaborative-code-editor, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vaibhavdevelopor/real-time-collaborative-code-editor
- Repository: https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor

## Overview

MaxHeap is a browser-based collaborative code editor. Users create or join a room, edit shared code, and receive synchronized edits and presence; they can also chat, save sessions, browse recent saves, and run code remotely. The room page orchestrates client UI and socket/OT hooks; server socket handlers coordinate room events and authoritative edits, with Redis document state and MongoDB session persistence. README documents seven execution languages and Redis/MongoDB tiers, but sampled code does not establish every persistence path or client execution wiring, so those edges are omitted where unverified.

Main entry points: [`client/src/pages/Room.jsx`](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/pages/Room.jsx) (Room orchestration), [`server/src/socket/editorHandler.js`](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/socket/editorHandler.js) (Edit event coordinator), [`server/server.js`](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/server.js) (HTTP and socket host), [`server/src/routes/rooms.js`](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/routes/rooms.js) (Room and run API)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Client experience"]
  node_app["Route shell<br/>[App.jsx]"]
  node_home["Room discovery<br/>[Home.jsx]"]
  node_room["Room orchestration<br/>[Room.jsx]"]
  node_editor["Code editor<br/>[Editor.jsx]"]
  node_cursors["Remote cursors<br/>[UserCursors.jsx]"]
  node_toolbar["Editor toolbar<br/>[Toolbar.jsx]"]
  node_chat["Room chat<br/>[Chat.jsx]"]
  node_output["Execution output<br/>[Output.jsx]"]
end

subgraph group_realtime["Realtime collaboration"]
  node_socket_hook["Socket client<br/>[useSocket.js]"]
  node_client_ot["Client OT state<br/>[useOT.js]"]
  node_client_transform["Client transform<br/>[transform.js]"]
  node_room_events["Room presence events<br/>[roomHandler.js]"]
  node_editor_events["Edit event coordinator<br/>[editorHandler.js]"]
  node_server_ot["Server OT engine<br/>[transform.js]"]
end

subgraph group_backend["Server services"]
  node_server["HTTP and socket host<br/>[server.js]"]
  node_auth["Authentication API<br/>[auth.js]"]
  node_rooms_api["Room and run API<br/>[rooms.js]"]
end

subgraph group_storage["Session storage"]
  node_redis[("Redis document cache")]
  node_sessions[("Session model<br/>[Session.js]")]
end

subgraph group_execution["Code execution"]
  node_paiza["Paiza execution service"]
end

node_user(("Collaborator"))

node_user -->|"opens editor"| node_app
node_app -->|"routes to"| node_home
node_app -->|"routes to"| node_room
node_user -->|"creates or joins"| node_home
node_room -->|"manages connection"| node_socket_hook
node_room -->|"manages OT"| node_client_ot
node_room -->|"renders"| node_editor
node_room -->|"renders"| node_chat
node_room -.->|"renders"| node_toolbar
node_room -.->|"renders"| node_output
node_editor -->|"renders"| node_cursors
node_client_ot -->|"transforms operations"| node_client_transform
node_socket_hook -.->|"sends edit events"| node_editor_events
node_socket_hook -.->|"sends room events"| node_room_events
node_server -->|"mounts routes"| node_auth
node_server -->|"mounts routes"| node_rooms_api
node_server -->|"registers handler"| node_room_events
node_server -->|"registers handler"| node_editor_events
node_editor_events -->|"transforms edits"| node_server_ot
node_editor_events -->|"reads and writes"| node_redis
node_editor_events -.->|"saves snapshots"| node_sessions
node_rooms_api -->|"reads and saves"| node_sessions
node_rooms_api -->|"submits and polls"| node_paiza
node_room -.->|"requests execution"| node_rooms_api

click node_app "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/App.jsx"
click node_home "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/pages/Home.jsx"
click node_room "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/pages/Room.jsx"
click node_editor "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/components/Editor.jsx"
click node_cursors "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/components/UserCursors.jsx"
click node_toolbar "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/components/Toolbar.jsx"
click node_chat "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/components/Chat.jsx"
click node_output "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/components/Output.jsx"
click node_socket_hook "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/hooks/useSocket.js"
click node_client_ot "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/hooks/useOT.js"
click node_client_transform "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/ot/transform.js"
click node_server "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/server.js"
click node_auth "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/routes/auth.js"
click node_rooms_api "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/routes/rooms.js"
click node_room_events "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/socket/roomHandler.js"
click node_editor_events "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/socket/editorHandler.js"
click node_server_ot "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/ot/transform.js"
click node_sessions "https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/models/Session.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_home,node_room,node_editor,node_cursors,node_toolbar,node_chat,node_output toneBlue
class node_socket_hook,node_client_ot,node_client_transform,node_room_events,node_editor_events,node_server_ot toneAmber
class node_server,node_auth,node_rooms_api toneMint
class node_redis,node_sessions toneRose
class node_paiza,node_user toneIndigo
```

## Components

### Client experience

- [Route shell](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/App.jsx): `client/src/App.jsx`
- [Room discovery](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/pages/Home.jsx): `client/src/pages/Home.jsx`
- [Room orchestration](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/pages/Room.jsx): `client/src/pages/Room.jsx`
- [Code editor](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/components/Editor.jsx): `client/src/components/Editor.jsx`
- [Remote cursors](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/components/UserCursors.jsx): `client/src/components/UserCursors.jsx`
- [Editor toolbar](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/components/Toolbar.jsx): `client/src/components/Toolbar.jsx`
- [Room chat](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/components/Chat.jsx): `client/src/components/Chat.jsx`
- [Execution output](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/components/Output.jsx): `client/src/components/Output.jsx`

### Realtime collaboration

- [Socket client](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/hooks/useSocket.js): `client/src/hooks/useSocket.js`
- [Client OT state](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/hooks/useOT.js): `client/src/hooks/useOT.js`
- [Client transform](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/client/src/ot/transform.js): `client/src/ot/transform.js`
- [Room presence events](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/socket/roomHandler.js): `server/src/socket/roomHandler.js`
- [Edit event coordinator](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/socket/editorHandler.js): `server/src/socket/editorHandler.js`
- [Server OT engine](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/ot/transform.js): `server/src/ot/transform.js`

### Server services

- [HTTP and socket host](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/server.js): `server/server.js`
- [Authentication API](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/routes/auth.js): `server/src/routes/auth.js`
- [Room and run API](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/routes/rooms.js): `server/src/routes/rooms.js`

### Session storage

- **Redis document cache**
- [Session model](https://github.com/vaibhavdevelopor/real-time-collaborative-code-editor/blob/main/server/src/models/Session.js): `server/src/models/Session.js`

### Code execution

- **Paiza execution service**

### Other components

- **Collaborator**

## Connections

- Collaborator → Route shell: opens editor (evidence: `client/src/App.jsx`)
- Route shell → Room discovery: routes to (evidence: `client/src/App.jsx`)
- Route shell → Room orchestration: routes to (evidence: `client/src/App.jsx`)
- Collaborator → Room discovery: creates or joins (evidence: `README.md`)
- Room orchestration → Socket client: manages connection (evidence: `client/src/pages/Room.jsx`)
- Room orchestration → Client OT state: manages OT (evidence: `client/src/pages/Room.jsx`)
- Room orchestration → Code editor: renders (evidence: `client/src/pages/Room.jsx`)
- Room orchestration → Room chat: renders (evidence: `client/src/pages/Room.jsx`)
- Room orchestration → Editor toolbar: renders (evidence: `client/src/pages/Room.jsx`)
- Room orchestration → Execution output: renders (evidence: `client/src/pages/Room.jsx`)
- Code editor → Remote cursors: renders (evidence: `client/src/components/Editor.jsx`)
- Client OT state → Client transform: transforms operations (evidence: `client/src/hooks/useOT.js`)
- Socket client → Edit event coordinator: sends edit events
- Socket client → Room presence events: sends room events
- HTTP and socket host → Authentication API: mounts routes (evidence: `server/server.js`)
- HTTP and socket host → Room and run API: mounts routes (evidence: `server/server.js`)
- HTTP and socket host → Room presence events: registers handler (evidence: `server/server.js`)
- HTTP and socket host → Edit event coordinator: registers handler (evidence: `server/server.js`)
- Edit event coordinator → Server OT engine: transforms edits (evidence: `server/src/socket/editorHandler.js`)
- Edit event coordinator → Redis document cache: reads and writes (evidence: `server/src/socket/editorHandler.js`)
- Edit event coordinator → Session model: saves snapshots (evidence: `server/src/socket/editorHandler.js`)
- Room and run API → Session model: reads and saves (evidence: `server/src/routes/rooms.js`)
- Room and run API → Paiza execution service: submits and polls (evidence: `server/src/routes/rooms.js`)
- Room orchestration → Room and run API: requests execution
