# foramgandhicodecraft/collaborative-code-editor architecture

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

- Interactive diagram: https://gitdiagram.com/foramgandhicodecraft/collaborative-code-editor
- Repository: https://github.com/foramgandhicodecraft/collaborative-code-editor

## Overview

CollabCode is a browser-based collaborative coding platform. Users create or join a room, edit per-language code together, share presence and chat, and can request AI help or run code; execution is queued for isolated worker execution. The graph also includes profile uploads and the separate admin surface. Relationships are grounded in the excerpts and README architecture; some route and UI internals were not sampled, so those links rely on documented capabilities rather than inferred implementation details.

Main entry points: [`client/src/pages/Editor.jsx`](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/pages/Editor.jsx) (Collaborative editor), [`server/socket/index.js`](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/index.js) (Socket event dispatcher), [`server/state/rooms.js`](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/state/rooms.js) (Room state), [`worker/worker.js`](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/worker/worker.js) (Execution worker)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Browser experience"]
  node_lobby["Room lobby<br/>[Lobby.jsx]"]
  node_editor["Collaborative editor<br/>[Editor.jsx]"]
  node_code_editor["Code editor view<br/>[CodeEditor.jsx]"]
  node_toolbar["Editor toolbar<br/>[Toolbar.jsx]"]
  node_output_panel["Output panel<br/>[OutputPanel.jsx]"]
  node_chat_panel["Chat panel<br/>[ChatPanel.jsx]"]
  node_users_sidebar["Users sidebar<br/>[UsersSidebar.jsx]"]
  node_ai_panel["AI assistant panel<br/>[AiPanel.jsx]"]
end

subgraph group_collaboration["Room collaboration"]
  node_yjs_client["Client Yjs documents<br/>[useYjs.js]"]
  node_socket_hook["Socket connection hook<br/>[useSocket.js]"]
  node_socket_server["Socket event dispatcher<br/>[index.js]"]
  node_room_handlers["Room membership<br/>[roomHandlers.js]"]
  node_yjs_handlers["Yjs synchronization<br/>[yjsHandlers.js]"]
  node_chat_handlers["Room chat<br/>[chatHandlers.js]"]
  node_awareness_handlers["Cursor presence"]
  node_room_state[("Room state<br/>[rooms.js]")]
end

subgraph group_execution["Code execution"]
  node_execution_handlers["Execution dispatch"]
  node_redis[("Redis job queue<br/>[redis.js]")]
  node_worker["Execution worker<br/>[worker.js]"]
  node_docker["Isolated containers"]
  node_output_route["Worker output endpoint<br/>[output.js]"]
end

subgraph group_services["Platform services"]
  node_server_entry["HTTP server entry<br/>[index.js]"]
  node_routes["HTTP route registry<br/>[index.js]"]
  node_ai_route["AI assistance endpoint<br/>[ai.js]"]
  node_ai_provider["AI provider"]
  node_upload_route["Profile upload endpoint<br/>[upload.js]"]
  node_cloudinary[("Cloudinary storage")]
end

subgraph group_admin["Administration"]
  node_admin_ui["Admin dashboard<br/>[AdminDashboard.jsx]"]
  node_admin_api["Admin API client<br/>[adminApi.js]"]
  node_admin_routes["Admin routes<br/>[admin.js]"]
  node_admin_auth["Admin authentication<br/>[auth.js]"]
  node_admin_session["Admin session tokens<br/>[adminSession.js]"]
  node_admin_guard["Admin route guard<br/>[AdminRoute.jsx]"]
end

node_participant(("Room participant"))

node_participant -->|"joins room"| node_lobby
node_lobby -->|"opens session"| node_editor
node_editor -->|"renders"| node_code_editor
node_editor -->|"renders"| node_toolbar
node_editor -->|"renders"| node_output_panel
node_editor -->|"renders"| node_chat_panel
node_editor -->|"renders"| node_users_sidebar
node_editor -->|"renders"| node_ai_panel
node_editor -->|"uses documents"| node_yjs_client
node_editor -->|"sends room events"| node_socket_server
node_yjs_client -->|"syncs updates"| node_socket_server
node_socket_server -->|"registers handlers"| node_room_handlers
node_socket_server -->|"registers handlers"| node_yjs_handlers
node_socket_server -->|"registers handlers"| node_chat_handlers
node_socket_server -->|"registers handlers"| node_awareness_handlers
node_room_handlers -->|"reads and updates"| node_room_state
node_yjs_handlers -->|"reads and updates"| node_room_state
node_chat_handlers -->|"uses room state"| node_room_state
node_awareness_handlers -->|"uses room state"| node_room_state
node_editor -->|"requests execution"| node_execution_handlers
node_execution_handlers -->|"queues job"| node_redis
node_redis -->|"dispatches job"| node_worker
node_worker -->|"runs code"| node_docker
node_worker -->|"posts output"| node_output_route
node_server_entry -->|"registers routes"| node_routes
node_server_entry -->|"starts sockets"| node_socket_server
node_routes -->|"mounts"| node_ai_route
node_ai_route -->|"requests inference"| node_ai_provider
node_editor -->|"requests assistance"| node_ai_route
node_routes -->|"mounts"| node_upload_route
node_upload_route -->|"stores profile image"| node_cloudinary
node_admin_ui -->|"calls API"| node_admin_api
node_admin_api -->|"sends requests"| node_admin_routes
node_admin_routes -->|"routes authentication"| node_admin_auth
node_admin_auth -->|"creates and verifies"| node_admin_session
node_admin_guard -->|"checks access"| node_admin_api

click node_lobby "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/pages/Lobby.jsx"
click node_editor "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/pages/Editor.jsx"
click node_code_editor "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/CodeEditor.jsx"
click node_toolbar "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/Toolbar.jsx"
click node_output_panel "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/OutputPanel.jsx"
click node_chat_panel "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/ChatPanel.jsx"
click node_users_sidebar "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/UsersSidebar.jsx"
click node_ai_panel "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/AiPanel.jsx"
click node_yjs_client "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/hooks/useYjs.js"
click node_socket_hook "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/hooks/useSocket.js"
click node_socket_server "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/index.js"
click node_room_handlers "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/roomHandlers.js"
click node_yjs_handlers "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/yjsHandlers.js"
click node_chat_handlers "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/chatHandlers.js"
click node_awareness_handlers "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/awarenessHandlers.js"
click node_room_state "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/state/rooms.js"
click node_execution_handlers "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/executionHandlers.js"
click node_redis "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/config/redis.js"
click node_worker "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/worker/worker.js"
click node_output_route "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/output.js"
click node_server_entry "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/index.js"
click node_routes "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/index.js"
click node_ai_route "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/ai.js"
click node_upload_route "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/upload.js"
click node_admin_ui "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/pages/Admin/AdminDashboard.jsx"
click node_admin_api "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/services/adminApi.js"
click node_admin_routes "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/admin.js"
click node_admin_auth "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/admin/auth.js"
click node_admin_session "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/utils/adminSession.js"
click node_admin_guard "https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/guards/AdminRoute.jsx"

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_lobby,node_editor,node_code_editor,node_toolbar,node_output_panel,node_chat_panel,node_users_sidebar,node_ai_panel toneBlue
class node_yjs_client,node_socket_hook,node_socket_server,node_room_handlers,node_yjs_handlers,node_chat_handlers,node_awareness_handlers,node_room_state toneAmber
class node_execution_handlers,node_redis,node_worker,node_docker,node_output_route toneMint
class node_server_entry,node_routes,node_ai_route,node_ai_provider,node_upload_route,node_cloudinary toneRose
class node_admin_ui,node_admin_api,node_admin_routes,node_admin_auth,node_admin_session,node_admin_guard,node_participant toneIndigo
```

## Components

### Browser experience

- [Room lobby](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/pages/Lobby.jsx): `client/src/pages/Lobby.jsx`
- [Collaborative editor](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/pages/Editor.jsx): `client/src/pages/Editor.jsx`
- [Code editor view](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/CodeEditor.jsx): `client/src/components/CodeEditor.jsx`
- [Editor toolbar](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/Toolbar.jsx): `client/src/components/Toolbar.jsx`
- [Output panel](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/OutputPanel.jsx): `client/src/components/OutputPanel.jsx`
- [Chat panel](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/ChatPanel.jsx): `client/src/components/ChatPanel.jsx`
- [Users sidebar](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/UsersSidebar.jsx): `client/src/components/UsersSidebar.jsx`
- [AI assistant panel](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/components/AiPanel.jsx): `client/src/components/AiPanel.jsx`

### Room collaboration

- [Client Yjs documents](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/hooks/useYjs.js): `client/src/hooks/useYjs.js`
- [Socket connection hook](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/hooks/useSocket.js): `client/src/hooks/useSocket.js`
- [Socket event dispatcher](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/index.js): `server/socket/index.js`
- [Room membership](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/roomHandlers.js): `server/socket/roomHandlers.js`
- [Yjs synchronization](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/yjsHandlers.js): `server/socket/yjsHandlers.js`
- [Room chat](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/chatHandlers.js): `server/socket/chatHandlers.js`
- [Cursor presence](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/awarenessHandlers.js): `server/socket/awarenessHandlers.js`
- [Room state](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/state/rooms.js): `server/state/rooms.js`

### Code execution

- [Execution dispatch](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/socket/executionHandlers.js): `server/socket/executionHandlers.js`
- [Redis job queue](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/config/redis.js): `server/config/redis.js`
- [Execution worker](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/worker/worker.js): `worker/worker.js`
- **Isolated containers**
- [Worker output endpoint](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/output.js): `server/routes/output.js`

### Platform services

- [HTTP server entry](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/index.js): `server/index.js`
- [HTTP route registry](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/index.js): `server/routes/index.js`
- [AI assistance endpoint](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/ai.js): `server/routes/ai.js`
- **AI provider**
- [Profile upload endpoint](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/upload.js): `server/routes/upload.js`
- **Cloudinary storage**

### Administration

- [Admin dashboard](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/pages/Admin/AdminDashboard.jsx): `client/src/pages/Admin/AdminDashboard.jsx`
- [Admin API client](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/services/adminApi.js): `client/src/services/adminApi.js`
- [Admin routes](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/admin.js): `server/routes/admin.js`
- [Admin authentication](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/routes/admin/auth.js): `server/routes/admin/auth.js`
- [Admin session tokens](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/server/utils/adminSession.js): `server/utils/adminSession.js`
- [Admin route guard](https://github.com/foramgandhicodecraft/collaborative-code-editor/blob/main/client/src/guards/AdminRoute.jsx): `client/src/guards/AdminRoute.jsx`

### Other components

- **Room participant**

## Connections

- Room participant → Room lobby: joins room (evidence: `README.md`)
- Room lobby → Collaborative editor: opens session (evidence: `client/src/App.jsx`)
- Collaborative editor → Code editor view: renders (evidence: `client/src/pages/Editor.jsx`)
- Collaborative editor → Editor toolbar: renders (evidence: `client/src/pages/Editor.jsx`)
- Collaborative editor → Output panel: renders (evidence: `client/src/pages/Editor.jsx`)
- Collaborative editor → Chat panel: renders (evidence: `client/src/pages/Editor.jsx`)
- Collaborative editor → Users sidebar: renders (evidence: `client/src/pages/Editor.jsx`)
- Collaborative editor → AI assistant panel: renders (evidence: `client/src/pages/Editor.jsx`)
- Collaborative editor → Client Yjs documents: uses documents (evidence: `client/src/pages/Editor.jsx`)
- Collaborative editor → Socket event dispatcher: sends room events (evidence: `README.md`)
- Client Yjs documents → Socket event dispatcher: syncs updates (evidence: `README.md`)
- Socket event dispatcher → Room membership: registers handlers (evidence: `server/socket/index.js`)
- Socket event dispatcher → Yjs synchronization: registers handlers (evidence: `server/socket/index.js`)
- Socket event dispatcher → Room chat: registers handlers (evidence: `server/socket/index.js`)
- Socket event dispatcher → Cursor presence: registers handlers (evidence: `server/socket/index.js`)
- Room membership → Room state: reads and updates (evidence: `server/socket/roomHandlers.js`)
- Yjs synchronization → Room state: reads and updates (evidence: `server/socket/yjsHandlers.js`)
- Room chat → Room state: uses room state (evidence: `server/socket/chatHandlers.js`)
- Cursor presence → Room state: uses room state (evidence: `server/socket/awarenessHandlers.js`)
- Collaborative editor → Execution dispatch: requests execution (evidence: `README.md`)
- Execution dispatch → Redis job queue: queues job (evidence: `README.md`)
- Redis job queue → Execution worker: dispatches job (evidence: `README.md`)
- Execution worker → Isolated containers: runs code (evidence: `README.md`)
- Execution worker → Worker output endpoint: posts output (evidence: `README.md`)
- HTTP server entry → HTTP route registry: registers routes (evidence: `server/index.js`)
- HTTP server entry → Socket event dispatcher: starts sockets (evidence: `server/index.js`)
- HTTP route registry → AI assistance endpoint: mounts (evidence: `server/routes/index.js`)
- AI assistance endpoint → AI provider: requests inference (evidence: `README.md`)
- Collaborative editor → AI assistance endpoint: requests assistance (evidence: `README.md`)
- HTTP route registry → Profile upload endpoint: mounts (evidence: `server/routes/index.js`)
- Profile upload endpoint → Cloudinary storage: stores profile image (evidence: `README.md`)
- Admin dashboard → Admin API client: calls API (evidence: `client/src/pages/Admin/AdminDashboard.jsx`)
- Admin API client → Admin routes: sends requests (evidence: `README.md`)
- Admin routes → Admin authentication: routes authentication (evidence: `server/routes/admin.js`)
- Admin authentication → Admin session tokens: creates and verifies (evidence: `server/routes/admin/auth.js`)
- Admin route guard → Admin API client: checks access (evidence: `client/src/guards/AdminRoute.jsx`)
