How sanshubhgupta/collab-editor works
This is a collaborative document editor: users sign in, create or select documents, edit shared Yjs state, and manage members and versions. The Next.js API handles document operations and access checks; a Socket.IO server coordinates live edits and presence, with Redis for cross-instance state and PostgreSQL persistence. The excerpts show these server-side links, but do not show the editor’s socket connection, so that relationship is left unasserted.
Main entry points: prisma.ts Prisma data access · CollaborativeEditor.tsx Collaborative editor · with-document-access.ts Document access checks · route.ts Version restore endpoint
Components 24
Web experience
- Dashboard
src/components/DashboardClient.tsx - Collaborative editor
src/components/CollaborativeEditor.tsx - Presence display
src/components/PresenceBar.tsx - Save status
src/components/SaveStatus.tsx - Manual save hook
src/hooks/useAutosave.ts - Sharing dialog
src/components/ShareModal.tsx - Version history
src/components/VersionHistory.tsx
Document API
- Document listing
src/app/api/documents/route.ts - Document management
src/app/api/documents/[id]/route.ts - Explicit save endpoint
src/app/api/documents/[id]/save/route.ts - Membership endpoint
src/app/api/documents/[id]/members/route.ts - Version endpoint
src/app/api/documents/[id]/versions/route.ts - Version restore endpoint
src/app/api/documents/[id]/versions/[versionId]/restore/route.ts - Document access checks
src/lib/with-document-access.ts
Collaboration runtime
- Realtime server
server/index.ts - Presence hook
src/hooks/usePresence.ts - Redis collaboration services
server/redis.ts
Identity and storage
- Document persistence
server/db-persist.ts - Authentication
src/auth.ts - GitHub sign-in policy
src/auth.config.ts - Prisma data access
src/lib/prisma.ts
Other components
- User
- PostgreSQL
- Redis
Connections 38
- User → Dashboard: uses
src/components/DashboardClient.tsx - User → Collaborative editor: edits
src/components/CollaborativeEditor.tsx - Dashboard → Document listing: requests documents
src/components/DashboardClient.tsx - Document listing → Authentication: authenticates
src/app/api/documents/route.ts - Document listing → Prisma data access: queries documents
src/app/api/documents/route.ts - Document listing → Redis collaboration services: gets online counts
src/app/api/documents/route.ts - Dashboard → Document management: renames or deletes
src/components/DashboardClient.tsx - Document management → Document access checks: checks permissions
src/app/api/documents/[id]/route.ts - Document management → Prisma data access: updates documents
src/app/api/documents/[id]/route.ts - Membership endpoint → Document access checks: checks permissions
src/app/api/documents/[id]/members/route.ts - Membership endpoint → Prisma data access: reads and updates members
src/app/api/documents/[id]/members/route.ts - Sharing dialog → Membership endpoint: manages members
src/components/ShareModal.tsx - Version endpoint → Document access checks: checks permissions
src/app/api/documents/[id]/versions/route.ts - Version endpoint → Prisma data access: reads and creates versions
src/app/api/documents/[id]/versions/route.ts - Version history → Version endpoint: loads versions
src/components/VersionHistory.tsx - Version history → Collaborative editor: uses editor
src/components/VersionHistory.tsx - Version restore endpoint → Document access checks: checks permissions
src/app/api/documents/[id]/versions/[versionId]/restore/route.ts - Version restore endpoint → Prisma data access: loads version data
src/app/api/documents/[id]/versions/[versionId]/restore/route.ts - Version restore endpoint → Redis collaboration services: publishes restored state
src/app/api/documents/[id]/versions/[versionId]/restore/route.ts - Version restore endpoint → Version history: restores version
- Collaborative editor → Manual save hook: uses save hook
src/components/CollaborativeEditor.tsx - Collaborative editor → Presence display: renders presence
src/components/CollaborativeEditor.tsx - Collaborative editor → Save status: renders status
src/components/CollaborativeEditor.tsx - Save status → Manual save hook: uses save state
src/components/SaveStatus.tsx - Manual save hook → Explicit save endpoint: posts document state
src/hooks/useAutosave.ts - Explicit save endpoint → Authentication: authenticates
src/app/api/documents/[id]/save/route.ts - Explicit save endpoint → Document access checks: checks permissions
src/app/api/documents/[id]/save/route.ts - Explicit save endpoint → Prisma data access: persists document
src/app/api/documents/[id]/save/route.ts - Authentication → GitHub sign-in policy: uses provider policy
src/auth.ts - Authentication → Prisma data access: configures adapter
src/auth.ts - Document access checks → Prisma data access: queries membership
src/lib/with-document-access.ts - Prisma data access → PostgreSQL: reads and writes
- Realtime server → Redis collaboration services: loads, publishes, tracks presence
server/index.ts - Realtime server → Document persistence: loads and saves state
server/index.ts - Document persistence → Prisma data access: uses database client
server/db-persist.ts - Redis collaboration services → Redis: caches and broadcasts
- Presence hook → Presence display: supplies presence
- Collaborative editor → Realtime server: syncs live edits