How jeet2005/nexsync works
NexSync is a collaborative writing app: users sign in, create or open a shared document, edit together, and optionally request a reviewable AI rewrite. The React app hosts the TipTap/Yjs editor, sends updates over WebSockets, and receives presence; FastAPI authenticates users, enforces document access, and persists collaboration state in PostgreSQL, with Redis for cross-instance fanout. Sharing, revision history, snapshots, and AI suggestions are additional capabilities. Source excerpts show key entry points, but not every route or persistence operation; README evidence supports the broader feature branches.
Main entry points: App.tsx App and editor · main.py Document API · db.py Database session · firebase.ts Firebase client
Components 20
Writing client
- App and editor
frontend/src/App.tsx - Firebase client
frontend/src/firebase.ts - Stale-edit guard
frontend/src/conflict.ts
API and identity
- Document API
backend/app/main.py - Token verification
backend/app/auth.py - Presence access grant
backend/app/presence.py - AI proposals
backend/app/main.py - Document sharing
backend/app/main.py - Revision history
backend/app/main.py
Collaboration runtime
- WebSocket collaboration
backend/app/main.py - Redis event relay
backend/app/main.py - Snapshot compaction
backend/app/main.py
Durable state
- Document data model
backend/app/models.py - Database session
backend/app/db.py
External services
- PostgreSQL
- Firebase Auth
- Realtime Database
- Redis Pub/Sub
- AI provider
Other components
- Writer
Connections 28
- Writer → App and editor: edits and requests
README.md - App and editor → Firebase client: uses
frontend/src/App.tsx - App and editor → Document API: calls document APIs
frontend/src/App.tsx - App and editor → WebSocket collaboration: exchanges Yjs updates
README.md - App and editor → Realtime Database: tracks presence
frontend/src/App.tsx - Firebase client → Firebase Auth: initializes auth
frontend/src/firebase.ts - Firebase client → Realtime Database: initializes database
frontend/src/firebase.ts - Document API → Token verification: verifies requests
backend/app/main.py - Document API → Database session: queries and writes
backend/app/main.py - Document API → Presence access grant: grants access
backend/app/main.py - Document API → Document sharing: handles sharing
README.md - Document API → Revision history: serves revisions
README.md - Document API → AI proposals: handles proposals
backend/app/main.py - Token verification → Firebase Auth: verifies identity
backend/app/auth.py - Presence access grant → Realtime Database: writes access grant
backend/app/presence.py - WebSocket collaboration → Token verification: authenticates connection
backend/app/main.py - WebSocket collaboration → Database session: persists updates
README.md - WebSocket collaboration → Redis event relay: publishes events
backend/app/main.py - Redis event relay → Redis Pub/Sub: publishes and subscribes
backend/app/main.py - WebSocket collaboration → Snapshot compaction: triggers compaction
backend/app/main.py - Snapshot compaction → Database session: stores snapshots
backend/app/main.py - Database session → Document data model: uses mapped entities
backend/app/main.py - Database session → PostgreSQL: stores durable state
README.md - AI proposals → AI provider: requests completion
backend/app/main.py - AI proposals → App and editor: returns proposal
README.md - App and editor → Stale-edit guard: checks target text
frontend/src/App.tsx - Stale-edit guard → App and editor: permits unchanged edits
frontend/src/conflict.ts - App and editor → Revision history: loads revision history
README.md