How ishan-gijavanekar/realtimedocumenteditor works
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: app.ts Express app · document.model.ts MongoDB records · permission.service.ts Access control · collaboration.socket.ts Live collaboration
Components 24
Web client
- Workspace view
frontend/src/pages/WorkspacePage.tsx - Editor components
frontend/src/components/DocumentEditor.tsx - Authentication context
frontend/src/context/AuthContext.tsx - Share page
frontend/src/pages/SharePage.tsx - API client
frontend/src/api/client.ts - Route shell
frontend/src/App.tsx
HTTP application
- Express app
backend/src/app.ts
Workspace and documents
- Workspace management
backend/src/controllers/workspace.controller.ts - Document management
backend/src/controllers/document.controller.ts - Access control
backend/src/services/permission.service.ts - Authentication
backend/src/services/auth.service.ts - Document search
backend/src/controllers/search.controller.ts
Collaboration features
- Comments
backend/src/controllers/comment.controller.ts - Share links
backend/src/controllers/share.controller.ts - Versions and restore
backend/src/controllers/version.controller.ts - Live collaboration
backend/src/sockets/collaboration.socket.ts
Persistence
- MongoDB records
backend/src/models/document.model.ts - User records
backend/src/models/user.model.ts - Workspace records
backend/src/models/workspace.model.ts - Comment records
backend/src/models/comment.model.ts - Version records
backend/src/models/version.model.ts - Share-link records
backend/src/models/share-link.model.ts
Other components
- User
- MongoDB
Connections 45
- User → Route shell: uses
frontend/src/App.tsx - Route shell → Workspace view: routes to
frontend/src/App.tsx - Route shell → Share page: routes to
frontend/src/App.tsx - Route shell → Authentication context: provides auth
frontend/src/App.tsx - Workspace view → API client: requests data
frontend/src/pages/WorkspacePage.tsx - Workspace view → Editor components: renders
frontend/src/pages/WorkspacePage.tsx - Share page → API client: requests data
frontend/src/pages/SharePage.tsx - Authentication context → API client: requests auth
frontend/src/context/AuthContext.tsx - API client → Express app: HTTP requests
README.md - Express app → Workspace management: routes to
backend/src/app.ts - Express app → Document management: routes to
backend/src/app.ts - Express app → Comments: routes to
backend/src/app.ts - Express app → Versions and restore: routes to
backend/src/app.ts - Express app → Document search: routes to
backend/src/app.ts - Express app → Share links: routes to
backend/src/app.ts - Workspace management → Access control: checks access
backend/src/controllers/workspace.controller.ts - Document management → Access control: checks access
backend/src/controllers/document.controller.ts - Comments → Access control: checks access
backend/src/controllers/comment.controller.ts - Versions and restore → Access control: checks access
backend/src/controllers/version.controller.ts - Document management → MongoDB records: reads and writes
backend/src/controllers/document.controller.ts - Workspace management → MongoDB records: reads and writes
backend/src/controllers/workspace.controller.ts - Workspace management → Workspace records: reads and writes
backend/src/controllers/workspace.controller.ts - Workspace management → User records: looks up users
backend/src/controllers/workspace.controller.ts - Access control → MongoDB records: reads documents
backend/src/services/permission.service.ts - Access control → Workspace records: reads memberships
backend/src/services/permission.service.ts - Authentication → User records: authenticates
backend/src/services/auth.service.ts - Comments → Comment records: reads and writes
backend/src/controllers/comment.controller.ts - Comments → MongoDB records: reads document
backend/src/controllers/comment.controller.ts - Versions and restore → MongoDB records: reads documents
backend/src/controllers/version.controller.ts - Versions and restore → Version records: stores snapshots
backend/src/controllers/version.controller.ts - Document management → Share-link records: creates links
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
backend/src/controllers/document.controller.ts - Comments → Live collaboration: broadcasts comments
backend/src/controllers/comment.controller.ts - User → Live collaboration: collaborates
README.md - Live collaboration → MongoDB records: reads and updates
backend/src/sockets/collaboration.socket.ts - Live collaboration → User records: authenticates users
backend/src/sockets/collaboration.socket.ts - Live collaboration → Access control: checks access
backend/src/sockets/collaboration.socket.ts - MongoDB records → MongoDB: persists in
README.md - Workspace records → MongoDB: persists in
README.md - User records → MongoDB: persists in
README.md - Comment records → MongoDB: persists in
README.md - Version records → MongoDB: persists in
README.md - Share-link records → MongoDB: persists in
README.md