# mohdarshadd/syncdoc architecture

> Architecture diagram of the GitHub repository mohdarshadd/syncdoc, 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/mohdarshadd/syncdoc
- Repository: https://github.com/mohdarshadd/syncdoc

## Overview

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: [`backend/src/routes/documents.js`](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/documents.js) (Document routes), [`backend/src/index.js`](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/index.js) (HTTP application), [`backend/src/models/Document.js`](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/Document.js) (Document model), [`backend/src/sync/server.js`](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/sync/server.js) (WebSocket sync)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Editor Client"]
  node_app["App routing<br/>[App.jsx]"]
  node_authui["Auth context<br/>[AuthContext.jsx]"]
  node_api["API client<br/>[api.js]"]
  node_browser["Document browser"]
  node_editor["Block editor<br/>[Editor.jsx]"]
  node_syncclient["Sync hook<br/>[useDocumentSync.js]"]
  node_blockstate["Block state<br/>[blockStore.js]"]
end

subgraph group_http["HTTP Product API"]
  node_httpserver["HTTP application<br/>[index.js]"]
  node_authroutes["Authentication<br/>[auth.js]"]
  node_authguard["Auth middleware<br/>[auth.js]"]
  node_documents["Document routes<br/>[documents.js]"]
  node_shares["Sharing routes<br/>[shares.js]"]
  node_versions["Version routes<br/>[versions.js]"]
  node_profile["Profile routes<br/>[profile.js]"]
end

subgraph group_collab["Realtime Collaboration"]
  node_wsserver["WebSocket sync<br/>[server.js]"]
  node_adapter["AST Yjs adapter<br/>[astAdapter.js]"]
  node_presence["Presence indicators<br/>[presence.js]"]
end

subgraph group_domain["Document Domain"]
  node_documentmodel["Document model<br/>[Document.js]"]
  node_astmodel["AST node schema<br/>[AstNode.js]"]
  node_validator["AST validation<br/>[ast.js]"]
  node_commentmodel["Comments<br/>[Comment.js]"]
  node_sharemodel["Share records<br/>[Share.js]"]
  node_versionmodel["Version snapshots<br/>[Version.js]"]
  node_userdb[("User records<br/>[User.js]")]
end

subgraph group_output["Import and Export"]
  node_security["Content sanitization<br/>[sanitize.js]"]
  node_markdown["Markdown transform<br/>[markdown.js]"]
  node_html["HTML transform<br/>[html.js]"]
  node_pdf["PDF transform<br/>[pdf.js]"]
end

node_user(("Document user"))
node_mongodb[("MongoDB")]
node_yjs[("Yjs document")]

node_user -->|"uses"| node_app
node_app -->|"provides auth"| node_authui
node_authui -->|"loads identity"| node_api
node_app -->|"routes to"| node_browser
node_app -->|"routes to"| node_editor
node_browser -.->|"requests documents"| node_api
node_editor -.->|"edits through"| node_syncclient
node_syncclient -->|"loads and saves"| node_api
node_syncclient -->|"updates CRDT"| node_yjs
node_syncclient -->|"merges deltas"| node_blockstate
node_user -->|"calls REST"| node_httpserver
node_httpserver -->|"mounts routes"| node_authroutes
node_httpserver -->|"mounts routes"| node_documents
node_httpserver -->|"mounts routes"| node_shares
node_httpserver -->|"mounts routes"| node_versions
node_httpserver -->|"mounts routes"| node_profile
node_httpserver -->|"attaches sync"| node_wsserver
node_authroutes -->|"reads and creates"| node_userdb
node_documents -->|"guards requests"| node_authguard
node_documents -->|"reads and writes"| node_documentmodel
node_documents -->|"checks and deletes shares"| node_sharemodel
node_documents -->|"builds AST"| node_validator
node_documents -->|"sanitizes content"| node_security
node_documents -->|"imports and exports"| node_markdown
node_documents -->|"exports HTML"| node_html
node_documents -->|"exports PDF"| node_pdf
node_documentmodel -->|"embeds nodes"| node_astmodel
node_documentmodel -->|"embeds comments"| node_commentmodel
node_documentmodel -->|"normalizes and validates"| node_validator
node_documentmodel -->|"records snapshots"| node_versionmodel
node_documentmodel -.->|"persists"| node_mongodb
node_wsserver -->|"loads and persists state"| node_documentmodel
node_wsserver -->|"checks access"| node_sharemodel
node_wsserver -->|"adapts document state"| node_adapter
node_wsserver -->|"syncs updates"| node_yjs
node_wsserver -->|"serves WebSocket"| node_user
node_html -->|"sanitizes output"| node_security
node_user -->|"sees collaborators"| node_presence
node_user -.->|"reviews history"| node_versions
node_user -.->|"shares documents"| node_shares
node_user -.->|"manages profile"| node_profile
node_user -->|"imports Markdown"| node_markdown
node_user -->|"exports HTML"| node_html
node_user -->|"exports PDF"| node_pdf

click node_app "https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/App.jsx"
click node_authui "https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/contexts/AuthContext.jsx"
click node_api "https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/api.js"
click node_browser "https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/components/DocumentBrowser.jsx"
click node_editor "https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/components/Editor.jsx"
click node_syncclient "https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/hooks/useDocumentSync.js"
click node_blockstate "https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/store/blockStore.js"
click node_httpserver "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/index.js"
click node_authroutes "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/auth.js"
click node_authguard "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/middleware/auth.js"
click node_documents "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/documents.js"
click node_shares "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/shares.js"
click node_versions "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/versions.js"
click node_profile "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/profile.js"
click node_wsserver "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/sync/server.js"
click node_adapter "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/sync/astAdapter.js"
click node_presence "https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/lib/presence.js"
click node_documentmodel "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/Document.js"
click node_astmodel "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/AstNode.js"
click node_validator "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/validators/ast.js"
click node_commentmodel "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/Comment.js"
click node_sharemodel "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/Share.js"
click node_versionmodel "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/Version.js"
click node_security "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/security/sanitize.js"
click node_markdown "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/transform/markdown.js"
click node_html "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/transform/html.js"
click node_pdf "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/transform/pdf.js"
click node_userdb "https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/User.js"

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_api,node_browser,node_editor,node_syncclient,node_blockstate,node_user toneBlue
class node_httpserver,node_authroutes,node_authguard,node_documents,node_shares,node_versions,node_profile,node_mongodb,node_yjs toneAmber
class node_wsserver,node_adapter,node_presence toneMint
class node_documentmodel,node_astmodel,node_validator,node_commentmodel,node_sharemodel,node_versionmodel,node_userdb toneRose
class node_security,node_markdown,node_html,node_pdf toneIndigo
```

## Components

### Editor Client

- [App routing](https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/App.jsx): `frontend/src/App.jsx`
- [Auth context](https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/contexts/AuthContext.jsx): `frontend/src/contexts/AuthContext.jsx`
- [API client](https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/api.js): `frontend/src/api.js`
- [Document browser](https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/components/DocumentBrowser.jsx): `frontend/src/components/DocumentBrowser.jsx`
- [Block editor](https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/components/Editor.jsx): `frontend/src/components/Editor.jsx`
- [Sync hook](https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/hooks/useDocumentSync.js): `frontend/src/hooks/useDocumentSync.js`
- [Block state](https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/store/blockStore.js): `frontend/src/store/blockStore.js`

### HTTP Product API

- [HTTP application](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/index.js): `backend/src/index.js`
- [Authentication](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/auth.js): `backend/src/routes/auth.js`
- [Auth middleware](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/middleware/auth.js): `backend/src/middleware/auth.js`
- [Document routes](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/documents.js): `backend/src/routes/documents.js`
- [Sharing routes](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/shares.js): `backend/src/routes/shares.js`
- [Version routes](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/versions.js): `backend/src/routes/versions.js`
- [Profile routes](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/routes/profile.js): `backend/src/routes/profile.js`

### Realtime Collaboration

- [WebSocket sync](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/sync/server.js): `backend/src/sync/server.js`
- [AST Yjs adapter](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/sync/astAdapter.js): `backend/src/sync/astAdapter.js`
- [Presence indicators](https://github.com/mohdarshadd/syncdoc/blob/main/frontend/src/lib/presence.js): `frontend/src/lib/presence.js`

### Document Domain

- [Document model](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/Document.js): `backend/src/models/Document.js`
- [AST node schema](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/AstNode.js): `backend/src/models/AstNode.js`
- [AST validation](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/validators/ast.js): `backend/src/validators/ast.js`
- [Comments](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/Comment.js): `backend/src/models/Comment.js`
- [Share records](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/Share.js): `backend/src/models/Share.js`
- [Version snapshots](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/Version.js): `backend/src/models/Version.js`
- [User records](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/models/User.js): `backend/src/models/User.js`

### Import and Export

- [Content sanitization](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/security/sanitize.js): `backend/src/security/sanitize.js`
- [Markdown transform](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/transform/markdown.js): `backend/src/transform/markdown.js`
- [HTML transform](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/transform/html.js): `backend/src/transform/html.js`
- [PDF transform](https://github.com/mohdarshadd/syncdoc/blob/main/backend/src/transform/pdf.js): `backend/src/transform/pdf.js`

### Other components

- **Document user**
- **MongoDB**
- **Yjs document**

## Connections

- Document user → App routing: uses (evidence: `README.md`)
- App routing → Auth context: provides auth (evidence: `frontend/src/App.jsx`)
- Auth context → API client: loads identity (evidence: `frontend/src/contexts/AuthContext.jsx`)
- App routing → Document browser: routes to (evidence: `frontend/src/App.jsx`)
- App routing → Block editor: routes to (evidence: `frontend/src/App.jsx`)
- Document browser → API client: requests documents
- Block editor → Sync hook: edits through
- Sync hook → API client: loads and saves (evidence: `frontend/src/hooks/useDocumentSync.js`)
- Sync hook → Yjs document: updates CRDT (evidence: `README.md`)
- Sync hook → Block state: merges deltas (evidence: `frontend/src/hooks/useDocumentSync.js`)
- Document user → HTTP application: calls REST (evidence: `README.md`)
- HTTP application → Authentication: mounts routes (evidence: `backend/src/index.js`)
- HTTP application → Document routes: mounts routes (evidence: `backend/src/index.js`)
- HTTP application → Sharing routes: mounts routes (evidence: `backend/src/index.js`)
- HTTP application → Version routes: mounts routes (evidence: `backend/src/index.js`)
- HTTP application → Profile routes: mounts routes (evidence: `backend/src/index.js`)
- HTTP application → WebSocket sync: attaches sync (evidence: `backend/src/index.js`)
- Authentication → User records: reads and creates (evidence: `backend/src/routes/auth.js`)
- Document routes → Auth middleware: guards requests (evidence: `backend/src/routes/documents.js`)
- Document routes → Document model: reads and writes (evidence: `backend/src/routes/documents.js`)
- Document routes → Share records: checks and deletes shares (evidence: `backend/src/routes/documents.js`)
- Document routes → AST validation: builds AST (evidence: `backend/src/routes/documents.js`)
- Document routes → Content sanitization: sanitizes content (evidence: `backend/src/routes/documents.js`)
- Document routes → Markdown transform: imports and exports (evidence: `backend/src/routes/documents.js`)
- Document routes → HTML transform: exports HTML (evidence: `backend/src/routes/documents.js`)
- Document routes → PDF transform: exports PDF (evidence: `backend/src/routes/documents.js`)
- Document model → AST node schema: embeds nodes (evidence: `backend/src/models/Document.js`)
- Document model → Comments: embeds comments (evidence: `backend/src/models/Document.js`)
- Document model → AST validation: normalizes and validates (evidence: `backend/src/models/Document.js`)
- Document model → Version snapshots: records snapshots (evidence: `backend/src/models/Document.js`)
- Document model → MongoDB: persists
- WebSocket sync → Document model: loads and persists state (evidence: `backend/src/sync/server.js`)
- WebSocket sync → Share records: checks access (evidence: `backend/src/sync/server.js`)
- WebSocket sync → AST Yjs adapter: adapts document state (evidence: `backend/src/sync/server.js`)
- WebSocket sync → Yjs document: syncs updates (evidence: `README.md`)
- WebSocket sync → Document user: serves WebSocket (evidence: `README.md`)
- HTML transform → Content sanitization: sanitizes output (evidence: `backend/src/transform/html.js`)
- Document user → Presence indicators: sees collaborators (evidence: `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 (evidence: `README.md`)
- Document user → HTML transform: exports HTML (evidence: `README.md`)
- Document user → PDF transform: exports PDF (evidence: `README.md`)
