Offline-first content platform consisting of an API, CMS and web app.

Name

lu·​mi·​nary - ˈlü-mə-ˌner-ē

1. a person of prominence or brilliant achievement
2. a body that gives light

Folder structure

• api: API layer over CouchDB
• app: Web and native frontend app
• cms: Backend CMS for managing content
• shared: Shared library used by the CMS and app
• docs: Cross-cutting documentation — see docs/README.md (ADRs, cross-package guides, architecture diagrams). Package-specific docs live with their code (each package's own README.md).

Architectural Decision Records

We record our decisions in the docs/adr folder. See the first ADR for more information on this process. You can install adr-tools to manage ADRs locally, such as creating one with this command:

adr new Branching strategy

Running Luminary

For Visual Studio Code users, ./.vscode/launch.json includes debug configurations for the API, CMS and reference App.

API

See the API readme

CMS

See the CMS readme

App

See the App readme

Shared library

See the Shared readme

Project automation

See the setup wizard guide