Skip to content

basic

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

basic

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
db
db
 
 
src/generated
src/generated
 
 
README.md
README.md
 
 
db.config.js
db.config.js
 
 
example.json
example.json
 
 
package.json
package.json
 
 

README.md

Basic Example

What This Teaches

Start here when you want the smallest schema-backed db workflow. It demonstrates sync, committed generated types, the local data explorer, file-backed .json REST reads, and creating a record.

Files To Inspect

Run It

From the repository root, use the repo-internal CLI path:

pnpm run db -- sync --cwd ./examples/basic
pnpm run db -- operations build --cwd ./examples/basic
pnpm run db -- serve --cwd ./examples/basic

Open the local data explorer:

http://127.0.0.1:7331/__db

Expected Result

sync writes generated schema, types, and runtime state under examples/basic/.db/, plus the committed type copy in src/generated/.

operations build writes a full server registry and client-safe refs under examples/basic/src/generated/.

To review the browser-facing operation contract without volatile timestamps:

pnpm run db -- operations contract --cwd ./examples/basic
pnpm run db -- operations contract --cwd ./examples/basic --check

REST Request To Try

Leave serve running and run this from another terminal:

curl http://127.0.0.1:7331/db/users.json

The .json route is intentional: a source data file such as db/users.json maps naturally to GET /db/users.json, while the server still reads from the synced runtime resource under .db/state.

Create a local runtime record:

curl -X POST http://127.0.0.1:7331/db/users \
  -H 'content-type: application/json' \
  -d '{"id":"u_2","name":"Grace Hopper","email":"grace@example.com"}'

The equivalent CLI smoke command is:

pnpm run db -- create users '{"id":"u_2","name":"Grace Hopper","email":"grace@example.com"}' --cwd ./examples/basic

Registered Operation To Try

Build operations, then use the generated ref from examples/basic/src/generated/db.operation-refs.json:

curl -X POST http://127.0.0.1:7331/__db/operations/REF \
  -H 'content-type: application/json' \
  -d '{"variables":{"id":"u_1"}}'

Features To Notice

Cleanup

Generated .db/ output is ignored by git and can be removed whenever you want a fresh mirror.

More Docs