stable
Playgrounds
Two guided, runnable demos: a 7-step interactive CLI tour and a full Nuxt 4 reference app whose build doubles as the family's integration test.
Two guided demos, both running against the published @noy-db/* packages — pick by how you like to explore. Clone the repo once (git clone https://github.com/noy-db/docs && cd noy-db-docs && pnpm install), then:
The CLI tour — pnpm demo
A 7-step interactive walkthrough in your terminal (non-interactive when piped, so it also runs in CI):
pnpm demo
- Encrypted CRUD on a file store — including a peek at the ciphertext envelope on disk.
- Multi-user access control — owner grants an operator (read/write) and a viewer (read-only); the viewer's forbidden write fails live.
- Offline → online sync — two "locations" with separate local stores push/pull through a shared backend.
- Conflict detection — the same record edited in both places, resolved by strategy.
- Backup & restore — encrypted dump, simulated disaster, full restore.
- Blob store — an attached PDF: encrypted, content-addressed, deduplicated.
- Audit history — versions, field-level diff, time-travel revert, pruning.
Everything runs in a temp directory and cleans up after itself.
The Nuxt reference app
A minimal but real Nuxt 4 application — module config, bootstrap plugin, defineNoydbStore stores, reactive query-driven pages:
pnpm --filter @noy-db/playground-nuxt dev # → http://localhost:3000
Worth trying while it runs:
- Edit the invoice list's filters — the reactive query DSL recomputes as you type.
- Open DevTools → Application → IndexedDB — every stored record is a ciphertext envelope (the browser form of See the ciphertext).
- The
/webauthnand/oidcpages drive realnavigator.credentialsand provider redirects — the flows the headless showcases (72–75) cover synthetically.
Its build doubles as the family's integration test: if this app builds, @noy-db/in-nuxt, in-pinia, in-vue, and the hub compose correctly.
See also
- Run the showcases — the full proof suite — every capability as a runnable test, one command.
- in-nuxt — the module the reference app is built on.
- Recipes overview — the copy-paste starter applications.