How jay4ignite/liveclass works
LiveClass IDE is a bring-your-own-IDE classroom: an instructor shares project edits from VS Code, while students receive an authorized, versioned mirror and can reconnect to converge. The VS Code controller coordinates login, class/session controls, transport, and IDE adapters; the sync engine applies edits, and the WebSocket gateway authorizes, sequences, and relays them. The API handles identity and session lifecycle, with PostgreSQL for durable records and Redis for collaboration state. The web dashboard is explicitly a stub. Some backend links are grounded in the SOURCE INDEX rather than complete excerpts; unsampled details are not expanded.
Main entry points: gateway.py WebSocket gateway · controller.ts VS Code controller · app.py ASGI app · authz.py Authorization
Components 33
IDE clients
- VS Code controller
extensions/vscode/src/controller.ts - API client
extensions/vscode/src/apiClient.ts - Reconnect manager
extensions/vscode/src/connectionManager.ts - IDE mirrors
extensions/vscode/src/vscodeAdapter.ts - Workspace approval
extensions/vscode/src/workspaceApproval.ts - WebSocket transport
extensions/vscode/src/wsTransport.ts
Protocol and sync
- Sync engine
packages/sync-engine/src/engine.ts - Edit operations
packages/sync-engine/src/edits.ts - Wire protocol models
packages/protocol/src/liveclass_protocol/models.py - TS validators
packages/shared-types/src/validators.ts
HTTP API
- ASGI app
services/collaboration/src/liveclass_collab/app.py - Authentication routes
services/api/src/liveclass_api/http/auth.py - Class routes
services/api/src/liveclass_api/http/classes.py - Session lifecycle
services/api/src/liveclass_api/http/sessions.py - Request dependencies
services/api/src/liveclass_api/http/deps.py - Authorization
services/api/src/liveclass_api/core/authz.py - JWT and passwords
services/api/src/liveclass_api/core/security.py - Runtime configuration
services/api/src/liveclass_api/core/config.py - Database access
services/api/src/liveclass_api/core/db.py - Durable domain models
services/api/src/liveclass_api/core/models.py - Logging setup
services/api/src/liveclass_api/core/logging.py
Collaboration backend
- WebSocket gateway
services/collaboration/src/liveclass_collab/gateway.py - Edit sequencer
services/collaboration/src/liveclass_collab/sequencer.py - Snapshot recovery
services/collaboration/src/liveclass_collab/snapshots.py - Presence tracking
services/collaboration/src/liveclass_collab/presence.py - Message rate limits
services/collaboration/src/liveclass_collab/ratelimit.py - Collaboration Redis
services/collaboration/src/liveclass_collab/redis_client.py
Web dashboard
- Dashboard stub
apps/web/src/App.tsx - Dashboard API calls
apps/web/src/api.ts
Other components
- Instructor
- Student
- PostgreSQL
- Redis
Connections 44
- Instructor → VS Code controller: operates
README.md - Student → VS Code controller: joins through
README.md - VS Code controller → API client: calls
extensions/vscode/src/controller.ts - VS Code controller → Reconnect manager: starts
extensions/vscode/src/controller.ts - VS Code controller → Sync engine: creates
extensions/vscode/src/controller.ts - VS Code controller → WebSocket transport: provides
extensions/vscode/src/controller.ts - VS Code controller → IDE mirrors: configures
extensions/vscode/src/controller.ts - IDE mirrors → Workspace approval: uses
extensions/vscode/src/workspaceApproval.ts - Sync engine → WebSocket transport: registers callbacks
packages/sync-engine/src/engine.ts - Sync engine → Edit operations: applies edits
packages/sync-engine/src/engine.ts - Sync engine → TS validators: validates messages
packages/sync-engine/src/engine.ts - Dashboard stub → Dashboard API calls: calls
apps/web/src/App.tsx - ASGI app → Logging setup: configures
services/collaboration/src/liveclass_collab/app.py - ASGI app → Authentication routes: registers
services/collaboration/src/liveclass_collab/app.py - ASGI app → Class routes: registers
services/collaboration/src/liveclass_collab/app.py - ASGI app → Session lifecycle: registers
services/collaboration/src/liveclass_collab/app.py - ASGI app → WebSocket gateway: registers
services/collaboration/src/liveclass_collab/app.py - Authentication routes → Authorization: authenticates through
services/api/src/liveclass_api/http/auth.py - Authentication routes → JWT and passwords: issues token
services/api/src/liveclass_api/http/auth.py - Authorization → Durable domain models: queries
services/api/src/liveclass_api/core/authz.py - Authorization → JWT and passwords: verifies password
services/api/src/liveclass_api/core/authz.py - Request dependencies → Authorization: loads identity
services/api/src/liveclass_api/http/deps.py - Request dependencies → JWT and passwords: decodes token
services/api/src/liveclass_api/http/deps.py - Request dependencies → Database access: gets session
services/api/src/liveclass_api/http/deps.py - Session lifecycle → Authorization: checks access
services/api/src/liveclass_api/http/sessions.py - Session lifecycle → Durable domain models: creates and updates
services/api/src/liveclass_api/http/sessions.py - Session lifecycle → Redis: publishes lifecycle events
services/api/src/liveclass_api/http/sessions.py - Durable domain models → Database access: uses base
services/api/src/liveclass_api/core/models.py - Database access → Runtime configuration: loads database settings
services/api/src/liveclass_api/core/db.py - JWT and passwords → Runtime configuration: loads JWT settings
services/api/src/liveclass_api/core/security.py - WebSocket gateway → Authorization: authorizes connections
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Durable domain models: loads session documents
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → JWT and passwords: verifies tokens
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Edit sequencer: sequences edits
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Snapshot recovery: recovers documents
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Presence tracking: tracks participants
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Message rate limits: limits messages
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Collaboration Redis: gets Redis
services/collaboration/src/liveclass_collab/gateway.py - Collaboration Redis → Redis: connects
services/collaboration/src/liveclass_collab/redis_client.py - Edit sequencer → Redis: stores edit state
- Snapshot recovery → PostgreSQL: persists checkpoints
- Database access → PostgreSQL: reads and writes
- API client → ASGI app: uses HTTP API
- Dashboard API calls → ASGI app: uses HTTP API