# dhanush299/codecollab-real-time-collaborative-code-editor architecture

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

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

## Overview

CodeCollab is a collaborative code editor whose main workflow is: authenticate, select or create a repository, edit and save files, then run code or enter a collaboration room. Repository and file APIs enforce access and persist project data; room APIs and Socket.IO support collaboration, chat, presence, and activity. The README also describes AI assistance, preview, and execution capabilities. Some backend route and room details are only partially sampled, so uncertain links are omitted or marked optional.

Main entry points: [`backend/routes/rooms.ts`](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/rooms.ts) (Room API), [`frontend/src/pages/Repository.tsx`](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/pages/Repository.tsx) (Repository editor), [`frontend/src/pages/Room.tsx`](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/pages/Room.tsx) (Collaboration room UI), [`frontend/src/App.tsx`](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/App.tsx) (App routing)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web client"]
  node_app["App routing<br/>[App.tsx]"]
  node_authui["Auth state<br/>[AuthContext.tsx]"]
  node_dashboard["Repository dashboard<br/>[Dashboard.tsx]"]
  node_repoeditor["Repository editor<br/>[Repository.tsx]"]
  node_filetree["File navigation<br/>[FileTree.tsx]"]
  node_runui["Run code UI<br/>[RunCodeModal.tsx]"]
  node_roomui["Collaboration room UI<br/>[Room.tsx]"]
  node_copilot["AI assistance UI<br/>[CopilotModal.tsx]"]
end

subgraph group_api["Backend APIs"]
  node_authapi["Authentication API<br/>[auth.ts]"]
  node_access["Access control<br/>[auth.ts]"]
  node_repoapi["Repository API<br/>[repositories.ts]"]
  node_fileapi["File API<br/>[files.ts]"]
  node_execution["Code execution<br/>[execution.ts]"]
  node_aiapi["AI and preview<br/>[ai.ts]"]
end

subgraph group_collaboration["Live collaboration"]
  node_roomapi["Room API<br/>[rooms.ts]"]
  node_socket["Realtime events<br/>[server.ts]"]
  node_activity["Room activity logging<br/>[logRoomActivity.ts]"]
end

subgraph group_data["Persistent data"]
  node_userstore[("User records<br/>[User.ts]")]
  node_repostore[("Repository records<br/>[Repository.ts]")]
  node_filestore[("File records<br/>[File.ts]")]
  node_revisionstore[("File revisions<br/>[FileRevision.ts]")]
  node_roomstore[("Room records<br/>[Room.ts]")]
  node_messagestore[("Chat messages<br/>[Message.ts]")]
  node_activitystore[("Activity records<br/>[RoomActivity.ts]")]
end

node_developer(("Developer"))

node_developer -->|"uses"| node_app
node_app -->|"provides auth"| node_authui
node_app -->|"routes to"| node_dashboard
node_app -->|"routes to"| node_repoeditor
node_app -->|"routes to"| node_roomui
node_authui -->|"calls"| node_authapi
node_dashboard -->|"reads identity"| node_authui
node_dashboard -->|"manages repositories"| node_repoapi
node_repoeditor -->|"loads repository"| node_repoapi
node_repoeditor -->|"loads and saves files"| node_fileapi
node_repoeditor -->|"renders navigation"| node_filetree
node_repoeditor -->|"opens runner"| node_runui
node_repoeditor -->|"creates room"| node_roomapi
node_runui -.->|"submits code"| node_execution
node_roomui -->|"reads identity"| node_authui
node_roomui -->|"uses navigation"| node_filetree
node_roomui -->|"opens assistance"| node_copilot
node_roomui -.->|"uses room services"| node_roomapi
node_roomui -.->|"exchanges live events"| node_socket
node_copilot -.->|"requests suggestions"| node_aiapi
node_authapi -->|"reads and writes"| node_userstore
node_access -->|"loads user"| node_userstore
node_access -->|"checks membership"| node_repostore
node_access -->|"resolves file access"| node_filestore
node_access -->|"checks participants"| node_roomstore
node_repoapi -->|"manages repositories"| node_repostore
node_repoapi -->|"accesses repository files"| node_filestore
node_fileapi -->|"manages files"| node_filestore
node_fileapi -->|"uses revisions"| node_revisionstore
node_execution -->|"logs activity"| node_activity
node_execution -->|"uses realtime service"| node_socket
node_roomapi -->|"manages rooms"| node_roomstore
node_roomapi -->|"resolves repository"| node_repostore
node_roomapi -->|"accesses chat"| node_messagestore
node_roomapi -->|"reads activity"| node_activitystore
node_roomapi -->|"logs room events"| node_activity
node_activity -->|"resolves room"| node_roomstore
node_activity -->|"persists activity"| node_activitystore
node_socket -->|"logs collaboration events"| node_activity

click node_app "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/App.tsx"
click node_authui "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/context/AuthContext.tsx"
click node_dashboard "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/pages/Dashboard.tsx"
click node_repoeditor "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/pages/Repository.tsx"
click node_filetree "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/components/FileTree.tsx"
click node_runui "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/components/RunCodeModal.tsx"
click node_roomui "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/pages/Room.tsx"
click node_copilot "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/components/CopilotModal.tsx"
click node_authapi "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/auth.ts"
click node_access "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/middleware/auth.ts"
click node_repoapi "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/repositories.ts"
click node_fileapi "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/files.ts"
click node_execution "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/execution.ts"
click node_aiapi "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/ai.ts"
click node_roomapi "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/rooms.ts"
click node_socket "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/server.ts"
click node_activity "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/utils/logRoomActivity.ts"
click node_userstore "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/User.ts"
click node_repostore "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/Repository.ts"
click node_filestore "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/File.ts"
click node_revisionstore "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/FileRevision.ts"
click node_roomstore "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/Room.ts"
click node_messagestore "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/Message.ts"
click node_activitystore "https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/RoomActivity.ts"

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_authui,node_dashboard,node_repoeditor,node_filetree,node_runui,node_roomui,node_copilot toneBlue
class node_authapi,node_access,node_repoapi,node_fileapi,node_execution,node_aiapi toneAmber
class node_roomapi,node_socket,node_activity toneMint
class node_userstore,node_repostore,node_filestore,node_revisionstore,node_roomstore,node_messagestore,node_activitystore toneRose
class node_developer toneIndigo
```

## Components

### Web client

- [App routing](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/App.tsx): `frontend/src/App.tsx`
- [Auth state](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/context/AuthContext.tsx): `frontend/src/context/AuthContext.tsx`
- [Repository dashboard](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/pages/Dashboard.tsx): `frontend/src/pages/Dashboard.tsx`
- [Repository editor](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/pages/Repository.tsx): `frontend/src/pages/Repository.tsx`
- [File navigation](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/components/FileTree.tsx): `frontend/src/components/FileTree.tsx`
- [Run code UI](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/components/RunCodeModal.tsx): `frontend/src/components/RunCodeModal.tsx`
- [Collaboration room UI](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/pages/Room.tsx): `frontend/src/pages/Room.tsx`
- [AI assistance UI](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/frontend/src/components/CopilotModal.tsx): `frontend/src/components/CopilotModal.tsx`

### Backend APIs

- [Authentication API](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/auth.ts): `backend/routes/auth.ts`
- [Access control](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/middleware/auth.ts): `backend/middleware/auth.ts`
- [Repository API](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/repositories.ts): `backend/routes/repositories.ts`
- [File API](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/files.ts): `backend/routes/files.ts`
- [Code execution](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/execution.ts): `backend/routes/execution.ts`
- [AI and preview](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/ai.ts): `backend/routes/ai.ts`

### Live collaboration

- [Room API](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/routes/rooms.ts): `backend/routes/rooms.ts`
- [Realtime events](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/server.ts): `backend/server.ts`
- [Room activity logging](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/utils/logRoomActivity.ts): `backend/utils/logRoomActivity.ts`

### Persistent data

- [User records](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/User.ts): `backend/models/User.ts`
- [Repository records](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/Repository.ts): `backend/models/Repository.ts`
- [File records](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/File.ts): `backend/models/File.ts`
- [File revisions](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/FileRevision.ts): `backend/models/FileRevision.ts`
- [Room records](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/Room.ts): `backend/models/Room.ts`
- [Chat messages](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/Message.ts): `backend/models/Message.ts`
- [Activity records](https://github.com/dhanush299/codecollab-real-time-collaborative-code-editor/blob/main/backend/models/RoomActivity.ts): `backend/models/RoomActivity.ts`

### Other components

- **Developer**

## Connections

- Developer → App routing: uses (evidence: `frontend/src/App.tsx`)
- App routing → Auth state: provides auth (evidence: `frontend/src/App.tsx`)
- App routing → Repository dashboard: routes to (evidence: `frontend/src/App.tsx`)
- App routing → Repository editor: routes to (evidence: `frontend/src/App.tsx`)
- App routing → Collaboration room UI: routes to (evidence: `frontend/src/App.tsx`)
- Auth state → Authentication API: calls (evidence: `frontend/src/context/AuthContext.tsx`)
- Repository dashboard → Auth state: reads identity (evidence: `frontend/src/pages/Dashboard.tsx`)
- Repository dashboard → Repository API: manages repositories (evidence: `frontend/src/pages/Dashboard.tsx`)
- Repository editor → Repository API: loads repository (evidence: `frontend/src/pages/Repository.tsx`)
- Repository editor → File API: loads and saves files (evidence: `frontend/src/pages/Repository.tsx`)
- Repository editor → File navigation: renders navigation (evidence: `frontend/src/pages/Repository.tsx`)
- Repository editor → Run code UI: opens runner (evidence: `frontend/src/pages/Repository.tsx`)
- Repository editor → Room API: creates room (evidence: `frontend/src/pages/Repository.tsx`)
- Run code UI → Code execution: submits code
- Collaboration room UI → Auth state: reads identity (evidence: `frontend/src/pages/Room.tsx`)
- Collaboration room UI → File navigation: uses navigation (evidence: `frontend/src/pages/Room.tsx`)
- Collaboration room UI → AI assistance UI: opens assistance (evidence: `frontend/src/pages/Room.tsx`)
- Collaboration room UI → Room API: uses room services
- Collaboration room UI → Realtime events: exchanges live events
- AI assistance UI → AI and preview: requests suggestions
- Authentication API → User records: reads and writes (evidence: `backend/routes/auth.ts`)
- Access control → User records: loads user (evidence: `backend/middleware/auth.ts`)
- Access control → Repository records: checks membership (evidence: `backend/middleware/auth.ts`)
- Access control → File records: resolves file access (evidence: `backend/middleware/auth.ts`)
- Access control → Room records: checks participants (evidence: `backend/middleware/auth.ts`)
- Repository API → Repository records: manages repositories (evidence: `backend/routes/repositories.ts`)
- Repository API → File records: accesses repository files (evidence: `backend/routes/repositories.ts`)
- File API → File records: manages files (evidence: `backend/routes/files.ts`)
- File API → File revisions: uses revisions (evidence: `backend/routes/files.ts`)
- Code execution → Room activity logging: logs activity (evidence: `backend/routes/execution.ts`)
- Code execution → Realtime events: uses realtime service (evidence: `backend/routes/execution.ts`)
- Room API → Room records: manages rooms (evidence: `backend/routes/rooms.ts`)
- Room API → Repository records: resolves repository (evidence: `backend/routes/rooms.ts`)
- Room API → Chat messages: accesses chat (evidence: `backend/routes/rooms.ts`)
- Room API → Activity records: reads activity (evidence: `backend/routes/rooms.ts`)
- Room API → Room activity logging: logs room events (evidence: `backend/routes/rooms.ts`)
- Room activity logging → Room records: resolves room (evidence: `backend/utils/logRoomActivity.ts`)
- Room activity logging → Activity records: persists activity (evidence: `backend/utils/logRoomActivity.ts`)
- Realtime events → Room activity logging: logs collaboration events (evidence: `backend/server.ts`)
