# ishan-gijavanekar/realtimedocumenteditor architecture

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

- Interactive diagram: https://gitdiagram.com/ishan-gijavanekar/realtimedocumenteditor
- Repository: https://github.com/ishan-gijavanekar/realtimedocumenteditor

## Overview

This is a real-time collaborative document editor. Users sign in, select or create a workspace, manage its document and folder tree, edit content, and collaborate through comments, sharing, versions, and search. The frontend calls the Express API; backend controllers apply membership and document permissions and persist domain records in MongoDB. Authenticated Socket.IO rooms broadcast document, comment, and presence events. The graph follows documented capabilities, but several routes and controllers were not excerpted, so their internal call relationships are omitted rather than inferred.

Main entry points: [`backend/src/app.ts`](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/app.ts) (Express app), [`backend/src/models/document.model.ts`](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/document.model.ts) (MongoDB records), [`backend/src/services/permission.service.ts`](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/services/permission.service.ts) (Access control), [`backend/src/sockets/collaboration.socket.ts`](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/sockets/collaboration.socket.ts) (Live collaboration)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web client"]
  node_workspace_ui["Workspace view<br/>[WorkspacePage.tsx]"]
  node_editor_ui["Editor components<br/>[DocumentEditor.tsx]"]
  node_auth_ui["Authentication context<br/>[AuthContext.tsx]"]
  node_share_ui["Share page<br/>[SharePage.tsx]"]
  node_api_client["API client<br/>[client.ts]"]
  node_app_shell["Route shell<br/>[App.tsx]"]
end

subgraph group_api["HTTP application"]
  node_express_app["Express app<br/>[app.ts]"]
end

subgraph group_domain["Workspace and documents"]
  node_workspace_ctrl["Workspace management"]
  node_document_ctrl["Document management"]
  node_permission["Access control"]
  node_auth_service["Authentication<br/>[auth.service.ts]"]
  node_search_ctrl["Document search"]
end

subgraph group_collab["Collaboration features"]
  node_comment_ctrl["Comments"]
  node_share_ctrl["Share links"]
  node_version_ctrl["Versions and restore"]
  node_socket_server["Live collaboration"]
end

subgraph group_data["Persistence"]
  node_database[("MongoDB records<br/>[document.model.ts]")]
  node_user_model[("User records<br/>[user.model.ts]")]
  node_workspace_model[("Workspace records<br/>[workspace.model.ts]")]
  node_comment_model[("Comment records<br/>[comment.model.ts]")]
  node_version_model[("Version records<br/>[version.model.ts]")]
  node_share_model[("Share-link records")]
end

node_user(("User"))
node_mongo[("MongoDB")]

node_user -->|"uses"| node_app_shell
node_app_shell -->|"routes to"| node_workspace_ui
node_app_shell -->|"routes to"| node_share_ui
node_app_shell -->|"provides auth"| node_auth_ui
node_workspace_ui -->|"requests data"| node_api_client
node_workspace_ui -->|"renders"| node_editor_ui
node_share_ui -->|"requests data"| node_api_client
node_auth_ui -->|"requests auth"| node_api_client
node_api_client -->|"HTTP requests"| node_express_app
node_express_app -->|"routes to"| node_workspace_ctrl
node_express_app -->|"routes to"| node_document_ctrl
node_express_app -->|"routes to"| node_comment_ctrl
node_express_app -->|"routes to"| node_version_ctrl
node_express_app -->|"routes to"| node_search_ctrl
node_express_app -->|"routes to"| node_share_ctrl
node_workspace_ctrl -->|"checks access"| node_permission
node_document_ctrl -->|"checks access"| node_permission
node_comment_ctrl -->|"checks access"| node_permission
node_version_ctrl -->|"checks access"| node_permission
node_document_ctrl -->|"reads and writes"| node_database
node_workspace_ctrl -->|"reads and writes"| node_database
node_workspace_ctrl -->|"reads and writes"| node_workspace_model
node_workspace_ctrl -->|"looks up users"| node_user_model
node_permission -->|"reads documents"| node_database
node_permission -->|"reads memberships"| node_workspace_model
node_auth_service -->|"authenticates"| node_user_model
node_comment_ctrl -->|"reads and writes"| node_comment_model
node_comment_ctrl -->|"reads document"| node_database
node_version_ctrl -->|"reads documents"| node_database
node_version_ctrl -->|"stores snapshots"| node_version_model
node_document_ctrl -->|"creates links"| node_share_model
node_share_ctrl -.->|"manages links"| node_share_model
node_search_ctrl -.->|"searches documents"| node_database
node_document_ctrl -->|"broadcasts patches"| node_socket_server
node_comment_ctrl -->|"broadcasts comments"| node_socket_server
node_user -.->|"collaborates"| node_socket_server
node_socket_server -->|"reads and updates"| node_database
node_socket_server -->|"authenticates users"| node_user_model
node_socket_server -->|"checks access"| node_permission
node_database -.->|"persists in"| node_mongo
node_workspace_model -.->|"persists in"| node_mongo
node_user_model -.->|"persists in"| node_mongo
node_comment_model -.->|"persists in"| node_mongo
node_version_model -.->|"persists in"| node_mongo
node_share_model -.->|"persists in"| node_mongo

click node_workspace_ui "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/pages/WorkspacePage.tsx"
click node_editor_ui "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/components/DocumentEditor.tsx"
click node_auth_ui "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/context/AuthContext.tsx"
click node_share_ui "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/pages/SharePage.tsx"
click node_api_client "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/api/client.ts"
click node_app_shell "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/App.tsx"
click node_express_app "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/app.ts"
click node_workspace_ctrl "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/workspace.controller.ts"
click node_document_ctrl "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/document.controller.ts"
click node_permission "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/services/permission.service.ts"
click node_auth_service "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/services/auth.service.ts"
click node_search_ctrl "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/search.controller.ts"
click node_comment_ctrl "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/comment.controller.ts"
click node_share_ctrl "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/share.controller.ts"
click node_version_ctrl "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/version.controller.ts"
click node_socket_server "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/sockets/collaboration.socket.ts"
click node_database "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/document.model.ts"
click node_user_model "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/user.model.ts"
click node_workspace_model "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/workspace.model.ts"
click node_comment_model "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/comment.model.ts"
click node_version_model "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/version.model.ts"
click node_share_model "https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/share-link.model.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_workspace_ui,node_editor_ui,node_auth_ui,node_share_ui,node_api_client,node_app_shell,node_user toneBlue
class node_express_app,node_mongo toneAmber
class node_workspace_ctrl,node_document_ctrl,node_permission,node_auth_service,node_search_ctrl toneMint
class node_comment_ctrl,node_share_ctrl,node_version_ctrl,node_socket_server toneRose
class node_database,node_user_model,node_workspace_model,node_comment_model,node_version_model,node_share_model toneIndigo
```

## Components

### Web client

- [Workspace view](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/pages/WorkspacePage.tsx): `frontend/src/pages/WorkspacePage.tsx`
- [Editor components](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/components/DocumentEditor.tsx): `frontend/src/components/DocumentEditor.tsx`
- [Authentication context](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/context/AuthContext.tsx): `frontend/src/context/AuthContext.tsx`
- [Share page](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/pages/SharePage.tsx): `frontend/src/pages/SharePage.tsx`
- [API client](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/api/client.ts): `frontend/src/api/client.ts`
- [Route shell](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/frontend/src/App.tsx): `frontend/src/App.tsx`

### HTTP application

- [Express app](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/app.ts): `backend/src/app.ts`

### Workspace and documents

- [Workspace management](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/workspace.controller.ts): `backend/src/controllers/workspace.controller.ts`
- [Document management](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/document.controller.ts): `backend/src/controllers/document.controller.ts`
- [Access control](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/services/permission.service.ts): `backend/src/services/permission.service.ts`
- [Authentication](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/services/auth.service.ts): `backend/src/services/auth.service.ts`
- [Document search](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/search.controller.ts): `backend/src/controllers/search.controller.ts`

### Collaboration features

- [Comments](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/comment.controller.ts): `backend/src/controllers/comment.controller.ts`
- [Share links](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/share.controller.ts): `backend/src/controllers/share.controller.ts`
- [Versions and restore](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/controllers/version.controller.ts): `backend/src/controllers/version.controller.ts`
- [Live collaboration](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/sockets/collaboration.socket.ts): `backend/src/sockets/collaboration.socket.ts`

### Persistence

- [MongoDB records](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/document.model.ts): `backend/src/models/document.model.ts`
- [User records](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/user.model.ts): `backend/src/models/user.model.ts`
- [Workspace records](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/workspace.model.ts): `backend/src/models/workspace.model.ts`
- [Comment records](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/comment.model.ts): `backend/src/models/comment.model.ts`
- [Version records](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/version.model.ts): `backend/src/models/version.model.ts`
- [Share-link records](https://github.com/ishan-gijavanekar/realtimedocumenteditor/blob/master/backend/src/models/share-link.model.ts): `backend/src/models/share-link.model.ts`

### Other components

- **User**
- **MongoDB**

## Connections

- User → Route shell: uses (evidence: `frontend/src/App.tsx`)
- Route shell → Workspace view: routes to (evidence: `frontend/src/App.tsx`)
- Route shell → Share page: routes to (evidence: `frontend/src/App.tsx`)
- Route shell → Authentication context: provides auth (evidence: `frontend/src/App.tsx`)
- Workspace view → API client: requests data (evidence: `frontend/src/pages/WorkspacePage.tsx`)
- Workspace view → Editor components: renders (evidence: `frontend/src/pages/WorkspacePage.tsx`)
- Share page → API client: requests data (evidence: `frontend/src/pages/SharePage.tsx`)
- Authentication context → API client: requests auth (evidence: `frontend/src/context/AuthContext.tsx`)
- API client → Express app: HTTP requests (evidence: `README.md`)
- Express app → Workspace management: routes to (evidence: `backend/src/app.ts`)
- Express app → Document management: routes to (evidence: `backend/src/app.ts`)
- Express app → Comments: routes to (evidence: `backend/src/app.ts`)
- Express app → Versions and restore: routes to (evidence: `backend/src/app.ts`)
- Express app → Document search: routes to (evidence: `backend/src/app.ts`)
- Express app → Share links: routes to (evidence: `backend/src/app.ts`)
- Workspace management → Access control: checks access (evidence: `backend/src/controllers/workspace.controller.ts`)
- Document management → Access control: checks access (evidence: `backend/src/controllers/document.controller.ts`)
- Comments → Access control: checks access (evidence: `backend/src/controllers/comment.controller.ts`)
- Versions and restore → Access control: checks access (evidence: `backend/src/controllers/version.controller.ts`)
- Document management → MongoDB records: reads and writes (evidence: `backend/src/controllers/document.controller.ts`)
- Workspace management → MongoDB records: reads and writes (evidence: `backend/src/controllers/workspace.controller.ts`)
- Workspace management → Workspace records: reads and writes (evidence: `backend/src/controllers/workspace.controller.ts`)
- Workspace management → User records: looks up users (evidence: `backend/src/controllers/workspace.controller.ts`)
- Access control → MongoDB records: reads documents (evidence: `backend/src/services/permission.service.ts`)
- Access control → Workspace records: reads memberships (evidence: `backend/src/services/permission.service.ts`)
- Authentication → User records: authenticates (evidence: `backend/src/services/auth.service.ts`)
- Comments → Comment records: reads and writes (evidence: `backend/src/controllers/comment.controller.ts`)
- Comments → MongoDB records: reads document (evidence: `backend/src/controllers/comment.controller.ts`)
- Versions and restore → MongoDB records: reads documents (evidence: `backend/src/controllers/version.controller.ts`)
- Versions and restore → Version records: stores snapshots (evidence: `backend/src/controllers/version.controller.ts`)
- Document management → Share-link records: creates links (evidence: `backend/src/controllers/document.controller.ts`)
- Share links → Share-link records: manages links
- Document search → MongoDB records: searches documents
- Document management → Live collaboration: broadcasts patches (evidence: `backend/src/controllers/document.controller.ts`)
- Comments → Live collaboration: broadcasts comments (evidence: `backend/src/controllers/comment.controller.ts`)
- User → Live collaboration: collaborates (evidence: `README.md`)
- Live collaboration → MongoDB records: reads and updates (evidence: `backend/src/sockets/collaboration.socket.ts`)
- Live collaboration → User records: authenticates users (evidence: `backend/src/sockets/collaboration.socket.ts`)
- Live collaboration → Access control: checks access (evidence: `backend/src/sockets/collaboration.socket.ts`)
- MongoDB records → MongoDB: persists in (evidence: `README.md`)
- Workspace records → MongoDB: persists in (evidence: `README.md`)
- User records → MongoDB: persists in (evidence: `README.md`)
- Comment records → MongoDB: persists in (evidence: `README.md`)
- Version records → MongoDB: persists in (evidence: `README.md`)
- Share-link records → MongoDB: persists in (evidence: `README.md`)
