How fixn222/qube works
Qube is a PostgreSQL developer workspace: users manage organizations and isolated project schemas through a Next.js dashboard or the qube-js SDK, while a NestJS API provides schema, data, SQL, REST, realtime, storage, and analytics capabilities. The graph follows the documented user-to-API-to-database flow and preserves major product branches. Some API internals are unsampled; those nodes use exact paths from the repository tree, and links are included only where the README or shown source supports them.
Main entry points: app Workspace UI · schema Qube metadata · client.ts Qube client · real-time Realtime streams
Components 19
Dashboard
- Workspace UI
apps/web/src/app
API services
- Organizations and members
apps/api/src/orgs - Authentication
apps/api/src/auth - Project provisioning
apps/api/src/projects/create-projects.service.ts - Schema workspace
apps/api/src/schema-introspection - Table editor
apps/api/src/table-editor/table-editor.service.ts - SQL editor
apps/api/src/sql-editor - Generated REST
apps/api/src/project-api/project-api.service.ts - Realtime streams
apps/api/src/real-time - Project storage
apps/api/src/storage/storage.service.ts - Analytics
apps/api/src/analytics/analytics.service.ts
Data and events
- Qube metadata
apps/api/src/db/schema - Project PostgreSQL
JavaScript SDK
- Qube client
packages/qube-js/src/client.ts - Database query builder
packages/qube-js/src/db/query-builder.ts - Realtime SDK
packages/qube-js/src/realtime/index.ts - Storage SDK
packages/qube-js/src/storage/index.ts
Other components
- User
- UploadThing
Connections 32
- User → Workspace UI: uses workspace
- Workspace UI → Authentication: authenticates via
- Workspace UI → Organizations and members: manages access
- Workspace UI → Project provisioning: creates projects
- Workspace UI → Schema workspace: inspects schema
- Workspace UI → Table editor: edits tables
- Workspace UI → SQL editor: runs SQL
- Workspace UI → Generated REST: explores endpoints
- Workspace UI → Realtime streams: configures streams
- Workspace UI → Project storage: manages files
- Workspace UI → Analytics: reviews activity
- Workspace UI → Project PostgreSQL: views project data
- Authentication → Qube metadata: stores accounts
apps/api/src/auth/guards/orgRole.guard.ts - Organizations and members → Qube metadata: stores membership
- Project provisioning → Qube metadata: records projects
- Project provisioning → Project PostgreSQL: provisions schema
- Schema workspace → Project PostgreSQL: inspects schema
- Table editor → Project PostgreSQL: changes tables
- SQL editor → Project PostgreSQL: executes queries
- Generated REST → Project PostgreSQL: serves table data
- Realtime streams → Project PostgreSQL: listens for changes
- Realtime streams → User: streams events
- Analytics → Qube metadata: records telemetry
- Project storage → Qube metadata: stores object records
apps/api/src/storage/storage.service.ts - Project storage → UploadThing: delegates uploads
- User → Qube client: uses client
- Qube client → Database query builder: provides queries
packages/qube-js/src/client.ts - Qube client → Realtime SDK: provides realtime
packages/qube-js/src/client.ts - Qube client → Storage SDK: provides storage
packages/qube-js/src/client.ts - Database query builder → Generated REST: queries endpoints
- Realtime SDK → Realtime streams: connects streams
- Storage SDK → Project storage: uses storage API