How mohdarshadd/syncdoc works
SyncDoc is a collaborative document editor. Users authenticate, browse or create documents, edit block content in a React editor, and receive concurrent changes through Yjs WebSockets; document state is persisted as validated AST trees. Sharing, comments, presence, version history and Markdown import/export broaden that workflow. Edges are limited to relationships shown in excerpts or explicitly documented in the README; unsampled features are included where documented, but their internal wiring is not inferred.
Main entry points: documents.js Document routes · index.js HTTP application · Document.js Document model · server.js WebSocket sync
Components 31
Editor Client
- App routing
frontend/src/App.jsx - Auth context
frontend/src/contexts/AuthContext.jsx - API client
frontend/src/api.js - Document browser
frontend/src/components/DocumentBrowser.jsx - Block editor
frontend/src/components/Editor.jsx - Sync hook
frontend/src/hooks/useDocumentSync.js - Block state
frontend/src/store/blockStore.js
HTTP Product API
- HTTP application
backend/src/index.js - Authentication
backend/src/routes/auth.js - Auth middleware
backend/src/middleware/auth.js - Document routes
backend/src/routes/documents.js - Sharing routes
backend/src/routes/shares.js - Version routes
backend/src/routes/versions.js - Profile routes
backend/src/routes/profile.js
Realtime Collaboration
- WebSocket sync
backend/src/sync/server.js - AST Yjs adapter
backend/src/sync/astAdapter.js - Presence indicators
frontend/src/lib/presence.js
Document Domain
- Document model
backend/src/models/Document.js - AST node schema
backend/src/models/AstNode.js - AST validation
backend/src/validators/ast.js - Comments
backend/src/models/Comment.js - Share records
backend/src/models/Share.js - Version snapshots
backend/src/models/Version.js - User records
backend/src/models/User.js
Import and Export
- Content sanitization
backend/src/security/sanitize.js - Markdown transform
backend/src/transform/markdown.js - HTML transform
backend/src/transform/html.js - PDF transform
backend/src/transform/pdf.js
Other components
- Document user
- MongoDB
- Yjs document
Connections 44
- Document user → App routing: uses
README.md - App routing → Auth context: provides auth
frontend/src/App.jsx - Auth context → API client: loads identity
frontend/src/contexts/AuthContext.jsx - App routing → Document browser: routes to
frontend/src/App.jsx - App routing → Block editor: routes to
frontend/src/App.jsx - Document browser → API client: requests documents
- Block editor → Sync hook: edits through
- Sync hook → API client: loads and saves
frontend/src/hooks/useDocumentSync.js - Sync hook → Yjs document: updates CRDT
README.md - Sync hook → Block state: merges deltas
frontend/src/hooks/useDocumentSync.js - Document user → HTTP application: calls REST
README.md - HTTP application → Authentication: mounts routes
backend/src/index.js - HTTP application → Document routes: mounts routes
backend/src/index.js - HTTP application → Sharing routes: mounts routes
backend/src/index.js - HTTP application → Version routes: mounts routes
backend/src/index.js - HTTP application → Profile routes: mounts routes
backend/src/index.js - HTTP application → WebSocket sync: attaches sync
backend/src/index.js - Authentication → User records: reads and creates
backend/src/routes/auth.js - Document routes → Auth middleware: guards requests
backend/src/routes/documents.js - Document routes → Document model: reads and writes
backend/src/routes/documents.js - Document routes → Share records: checks and deletes shares
backend/src/routes/documents.js - Document routes → AST validation: builds AST
backend/src/routes/documents.js - Document routes → Content sanitization: sanitizes content
backend/src/routes/documents.js - Document routes → Markdown transform: imports and exports
backend/src/routes/documents.js - Document routes → HTML transform: exports HTML
backend/src/routes/documents.js - Document routes → PDF transform: exports PDF
backend/src/routes/documents.js - Document model → AST node schema: embeds nodes
backend/src/models/Document.js - Document model → Comments: embeds comments
backend/src/models/Document.js - Document model → AST validation: normalizes and validates
backend/src/models/Document.js - Document model → Version snapshots: records snapshots
backend/src/models/Document.js - Document model → MongoDB: persists
- WebSocket sync → Document model: loads and persists state
backend/src/sync/server.js - WebSocket sync → Share records: checks access
backend/src/sync/server.js - WebSocket sync → AST Yjs adapter: adapts document state
backend/src/sync/server.js - WebSocket sync → Yjs document: syncs updates
README.md - WebSocket sync → Document user: serves WebSocket
README.md - HTML transform → Content sanitization: sanitizes output
backend/src/transform/html.js - Document user → Presence indicators: sees collaborators
README.md - Document user → Version routes: reviews history
- Document user → Sharing routes: shares documents
- Document user → Profile routes: manages profile
- Document user → Markdown transform: imports Markdown
README.md - Document user → HTML transform: exports HTML
README.md - Document user → PDF transform: exports PDF
README.md