How bccsa/luminary works
Luminary is an offline-first content platform with a public app, an editorial CMS, a shared client library, and a CouchDB-backed API. The reader workflow is to browse or search content, receive locally available results, and synchronize data with the API; the editorial workflow is to manage content and related platform settings through the CMS. The graph preserves major capabilities visible in the tree, including recommendations, full-text search, static rendering, media storage, and access control. Some of these branches are represented by their source paths because their implementation was not sampled.
Main entry points: src/pages Reader app · src/pages Editorial CMS · HybridQuery.ts Hybrid queries · authIdentity.service.ts Authentication
Components 24
User clients
- Reader app
app/src/pages - Editorial CMS
cms/src/pages - Content queries
app/src/composables/useContentQuery.ts - Content editing
cms/src/components/content - Recommendations
app/src/recommendation - Static rendering
app/src/ssg
Shared runtime
- Shared client library
shared/src/index.ts - Hybrid queries
shared/src/util/HybridQuery/HybridQuery.ts - Local database
shared/src/db/database.ts - Offline sync
shared/src/api/sync - Full-text search
shared/src/fts - Worker tasks
shared/src/worker/workerClient.ts
API services
- Query endpoint
api/src/endpoints/query.controller.ts - Query service
api/src/endpoints/query.service.ts - Change requests
api/src/endpoints/changeRequest.service.ts - Authentication
api/src/auth/authIdentity.service.ts - Access control
api/src/permissions/permissions.service.ts - Media and storage
api/src/s3/s3.service.ts
Persistence and integrations
- Database service
api/src/db/db.service.ts - CouchDB
- Object storage
- Identity provider
Other components
- Reader
- Editor
Connections 25
- Reader → Reader app: uses
- Editor → Editorial CMS: uses
- Reader app → Content queries: requests content
- Editorial CMS → Content editing: edits content
- Content queries → Hybrid queries: queries through
- Hybrid queries → Local database: queries locally
shared/src/util/HybridQuery/HybridQuery.ts - Hybrid queries → Worker tasks: dispatches tasks
shared/src/util/HybridQuery/HybridQuery.ts - Hybrid queries → Offline sync: synchronizes via
shared/src/util/HybridQuery/HybridQuery.ts - Reader app → Recommendations: uses
- Reader app → Full-text search: searches with
- Reader app → Static rendering: renders statically
- Editorial CMS → Full-text search: searches with
- Reader app → Shared client library: uses library
- Editorial CMS → Shared client library: uses library
- Query endpoint → Query service: calls
api/src/endpoints/query.controller.ts - Query service → Database service: queries
api/src/endpoints/query.service.ts - Query service → Access control: checks access
api/src/endpoints/query.service.ts - Query endpoint → Authentication: guards request
api/src/endpoints/query.controller.ts - Authentication → Database service: loads identity data
api/src/auth/authIdentity.service.ts - Authentication → Access control: uses access map
api/src/auth/authIdentity.service.ts - Content editing → Change requests: submits changes
- Change requests → Database service: persists changes
- Database service → CouchDB: reads and writes
- Media and storage → Object storage: stores media
- Authentication → Identity provider: validates tokens
api/src/auth/authIdentity.service.ts