How dhanush299/codecollab-real-time-collaborative-code-editor works
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: rooms.ts Room API · Repository.tsx Repository editor · Room.tsx Collaboration room UI · App.tsx App routing
Components 25
Web client
- App routing
frontend/src/App.tsx - Auth state
frontend/src/context/AuthContext.tsx - Repository dashboard
frontend/src/pages/Dashboard.tsx - Repository editor
frontend/src/pages/Repository.tsx - File navigation
frontend/src/components/FileTree.tsx - Run code UI
frontend/src/components/RunCodeModal.tsx - Collaboration room UI
frontend/src/pages/Room.tsx - AI assistance UI
frontend/src/components/CopilotModal.tsx
Backend APIs
- Authentication API
backend/routes/auth.ts - Access control
backend/middleware/auth.ts - Repository API
backend/routes/repositories.ts - File API
backend/routes/files.ts - Code execution
backend/routes/execution.ts - AI and preview
backend/routes/ai.ts
Live collaboration
- Room API
backend/routes/rooms.ts - Realtime events
backend/server.ts - Room activity logging
backend/utils/logRoomActivity.ts
Persistent data
- User records
backend/models/User.ts - Repository records
backend/models/Repository.ts - File records
backend/models/File.ts - File revisions
backend/models/FileRevision.ts - Room records
backend/models/Room.ts - Chat messages
backend/models/Message.ts - Activity records
backend/models/RoomActivity.ts
Other components
- Developer
Connections 39
- Developer → App routing: uses
frontend/src/App.tsx - App routing → Auth state: provides auth
frontend/src/App.tsx - App routing → Repository dashboard: routes to
frontend/src/App.tsx - App routing → Repository editor: routes to
frontend/src/App.tsx - App routing → Collaboration room UI: routes to
frontend/src/App.tsx - Auth state → Authentication API: calls
frontend/src/context/AuthContext.tsx - Repository dashboard → Auth state: reads identity
frontend/src/pages/Dashboard.tsx - Repository dashboard → Repository API: manages repositories
frontend/src/pages/Dashboard.tsx - Repository editor → Repository API: loads repository
frontend/src/pages/Repository.tsx - Repository editor → File API: loads and saves files
frontend/src/pages/Repository.tsx - Repository editor → File navigation: renders navigation
frontend/src/pages/Repository.tsx - Repository editor → Run code UI: opens runner
frontend/src/pages/Repository.tsx - Repository editor → Room API: creates room
frontend/src/pages/Repository.tsx - Run code UI → Code execution: submits code
- Collaboration room UI → Auth state: reads identity
frontend/src/pages/Room.tsx - Collaboration room UI → File navigation: uses navigation
frontend/src/pages/Room.tsx - Collaboration room UI → AI assistance UI: opens assistance
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
backend/routes/auth.ts - Access control → User records: loads user
backend/middleware/auth.ts - Access control → Repository records: checks membership
backend/middleware/auth.ts - Access control → File records: resolves file access
backend/middleware/auth.ts - Access control → Room records: checks participants
backend/middleware/auth.ts - Repository API → Repository records: manages repositories
backend/routes/repositories.ts - Repository API → File records: accesses repository files
backend/routes/repositories.ts - File API → File records: manages files
backend/routes/files.ts - File API → File revisions: uses revisions
backend/routes/files.ts - Code execution → Room activity logging: logs activity
backend/routes/execution.ts - Code execution → Realtime events: uses realtime service
backend/routes/execution.ts - Room API → Room records: manages rooms
backend/routes/rooms.ts - Room API → Repository records: resolves repository
backend/routes/rooms.ts - Room API → Chat messages: accesses chat
backend/routes/rooms.ts - Room API → Activity records: reads activity
backend/routes/rooms.ts - Room API → Room activity logging: logs room events
backend/routes/rooms.ts - Room activity logging → Room records: resolves room
backend/utils/logRoomActivity.ts - Room activity logging → Activity records: persists activity
backend/utils/logRoomActivity.ts - Realtime events → Room activity logging: logs collaboration events
backend/server.ts