How ikumar200/livedocs works
Project Type & Purpose
– This is a full-stack, real-time collaborative document editor built on Next.js 13 (App Router).
– It uses Convex as a BaaS for persistence and business logic, and Liveblocks for real-time presence and synchronization.
High-Level Components
A. Browser Clients
• Next.js rendered UI (Server Components + Client Components)
• Tiptap-based rich-text editor with custom extensions (font-size, line-height)
• Zustand-style store hooks (use-editor-store, use-toast)
• Convex client (via convex-client-provider)
• Liveblocks client (connected via WebSocket)
B. Next.js App (deployed on Vercel)
• App Router routes (/, /documents/[documentId])
• API Route: /api/liveblocks-auth → issues Liveblocks auth tokens
• Server Components: layout.tsx, navbar, global CSS, font loading
• Client Components: document-input, editor, toolbar, threads, room, ruler
C. Convex Backend Service
• Schema (convex/schema.ts) defining Documents, Threads, Comments
• Documents logic (convex/documents.ts) for CRUD & real-time subscriptions
• Generated API & server code (convex/_generated)
• Auth config (convex/auth.config.ts) integrating user identity
D. Liveblocks Real-Time Service
• Room management (presence, cursors, storage)
• Access controlled via tokens from Next.js API
E. External Infrastructure
• Vercel Hosting + CDN for static assets (public/)
• npm ecosystem (Tailwind, PostCSS, ESlint, TypeScript)
Component Interactions & Data Flows
1) User opens app → Next.js SSR/SSG serves HTML + JS
2) Browser initializes Convex client → fetches document list/table
3) On “open document”:
• Client subscribes to Convex live query for content
• Client calls Next.js /api/liveblocks-auth → receives Liveblocks token
• Client connects to Liveblocks WebSocket room for real-time edits
4) Editing workflow:
• Local Tiptap changes → update client store →
• Broadcast to Liveblocks peers → merge and display cursors
• On save or auto-save → send mutation to Convex → persist to DB
• Convex push updates to other subscribers
Architectural Patterns & Principles
– BaaS/CaaS: Convex abstracts server logic, data model, subscriptions
– Pub/Sub Real-Time: Liveblocks for low-latency collaborative events
– Hybrid Rendering: Next.js Server Components for layout & data fetching, Client Components for interactivity
– Separation of Concerns:
• UI & styling in /components/ui + Tailwind
• Business logic in convex/
• Real-time logic in Liveblocks API route + client
Representation Details
– Clear labels for: Next.js SSR, Server Components, Client Components, API Routes