How jay4ignite/liveclass-ide works
LiveClass IDE is a teacher-led, real-time programming classroom: the teacher shares VS Code project edits, while students receive authorized read-only mirrors and reconnect by reconverging state. The walking-skeleton workflow runs from sign-in and session setup through WebSocket synchronization, server-side authorization and sequencing, then student workspace updates. The README also describes protocol packages and a stub dashboard; storage separates durable PostgreSQL records from ephemeral Redis collaboration state. Several important backend details are indexed but not excerpted, so their specific call relationships are omitted.
Main entry points: gateway.py WebSocket gateway · controller.ts VS Code extension · authz.py Identity and authorization · app.py ASGI app
Components 26
Client applications
- VS Code extension
extensions/vscode/src/controller.ts - Workspace adapter
extensions/vscode/src/vscodeAdapter.ts - Reconnect manager
extensions/vscode/src/connectionManager.ts - WebSocket transport
extensions/vscode/src/wsTransport.ts - API client
extensions/vscode/src/apiClient.ts - Dashboard stub
apps/web/src/App.tsx
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 - Shared TS validators
packages/shared-types/src/validators.ts
API and authorization
- ASGI app
services/collaboration/src/liveclass_collab/app.py - Authentication routes
services/api/src/liveclass_api/http/auth.py - Session lifecycle
services/api/src/liveclass_api/http/sessions.py - Class routes
services/api/src/liveclass_api/http/classes.py - Identity and authorization
services/api/src/liveclass_api/core/authz.py - Password and JWT
services/api/src/liveclass_api/core/security.py - HTTP auth dependencies
services/api/src/liveclass_api/http/deps.py
Real-time collaboration
- WebSocket gateway
services/collaboration/src/liveclass_collab/gateway.py - Edit sequencer
services/collaboration/src/liveclass_collab/sequencer.py - Presence tracking
services/collaboration/src/liveclass_collab/presence.py - Snapshot recovery
services/collaboration/src/liveclass_collab/snapshots.py - Connection rate limit
services/collaboration/src/liveclass_collab/ratelimit.py
Persistence
- PostgreSQL records
services/api/src/liveclass_api/core/models.py - Redis state and pub/sub
services/collaboration/src/liveclass_collab/redis_client.py
Other components
- Teacher
- Student
Connections 34
- Teacher → VS Code extension: authors in
- Student → VS Code extension: joins in
- VS Code extension → API client: authenticates and manages sessions
extensions/vscode/src/controller.ts - VS Code extension → Sync engine: creates
extensions/vscode/src/controller.ts - VS Code extension → Reconnect manager: starts reconnects
extensions/vscode/src/controller.ts - VS Code extension → WebSocket transport: configures
extensions/vscode/src/controller.ts - VS Code extension → Workspace adapter: sets up sharing or mirroring
extensions/vscode/src/controller.ts - Dashboard stub → API client: calls API
apps/web/src/App.tsx - Sync engine → Edit operations: applies and normalizes
packages/sync-engine/src/engine.ts - Sync engine → Shared TS validators: validates messages
packages/sync-engine/src/engine.ts - Sync engine → WebSocket transport: sends and receives
- ASGI app → Authentication routes: mounts
services/collaboration/src/liveclass_collab/app.py - ASGI app → Class routes: mounts
services/collaboration/src/liveclass_collab/app.py - ASGI app → Session lifecycle: mounts
services/collaboration/src/liveclass_collab/app.py - ASGI app → WebSocket gateway: mounts
services/collaboration/src/liveclass_collab/app.py - Authentication routes → Identity and authorization: authenticates user
services/api/src/liveclass_api/http/auth.py - Authentication routes → Password and JWT: issues token
services/api/src/liveclass_api/http/auth.py - Identity and authorization → Password and JWT: verifies password
services/api/src/liveclass_api/core/authz.py - HTTP auth dependencies → Password and JWT: verifies token
services/api/src/liveclass_api/http/deps.py - HTTP auth dependencies → Identity and authorization: loads user
services/api/src/liveclass_api/http/deps.py - Identity and authorization → PostgreSQL records: queries identity and membership
services/api/src/liveclass_api/core/authz.py - Session lifecycle → Redis state and pub/sub: publishes lifecycle events
services/api/src/liveclass_api/http/sessions.py - Session lifecycle → PostgreSQL records: persists session state
services/api/src/liveclass_api/http/sessions.py - WebSocket gateway → Identity and authorization: authorizes connection
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Password and JWT: verifies token
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Wire protocol models: parses messages
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Edit sequencer: sequences edits
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Presence tracking: tracks participants
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Snapshot recovery: recovers document state
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Connection rate limit: limits inbound messages
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → Redis state and pub/sub: publishes and subscribes
services/collaboration/src/liveclass_collab/gateway.py - WebSocket gateway → PostgreSQL records: loads session documents
services/collaboration/src/liveclass_collab/gateway.py - Edit sequencer → Redis state and pub/sub: stores versioned operations
- Snapshot recovery → PostgreSQL records: persists checkpoints
services/collaboration/src/liveclass_collab/snapshots.py