Developer quickstart

Your first Chef project.

Run Chef in your environment. Connect a Prep source. Turn public Zcash data into your own GraphQL API.

Preview release · Linux / WSL2 · Node 24.14+ · packages installed from local tarballs

1. Prepare your packages

Clone the repository and pack both packages. Chef builds during packing; the packages are not yet published to npm.

git clone https://github.com/EndPx/zeer.gitcd zeernpm cimkdir -p .tmp/chef-packagesnpm pack ./packages/prep-client --pack-destination .tmp/chef-packagesnpm pack ./packages/chef --pack-destination .tmp/chef-packages

2. Create an independent project

Choose a start height your testnet Prep archive covers. The target directory must not already exist.

node packages/chef/dist/cli.js init \  --dir ../my-indexer \  --project my_indexer \  --start-height 0cd ../my-indexernpm install ../zeer/.tmp/chef-packages/zeer-prep-client-0.1.0.tgz \  ../zeer/.tmp/chef-packages/zeer-chef-0.1.0.tgznpm run codegennpm run typecheck

3. Connect your data

Edit the generated, git-ignored .env: set your actual PREP_URL, optional Prep token, and PostgreSQL DATABASE_URL. Use the public testnet endpoint below or your own Prep source. Check its current coverage before indexing; the preview requires no personal API token.

PREP_URL=https://zeer.endpx.cloud/api/prepPREP_API_TOKEN=
Check current coverage ↗

The starter includes optional PostgreSQL via Docker Compose. Skip this command when using an existing database.

npm run db:upnpm run migratenpm run status

4. Index, then query

Set an end height available in Prep. Sync uses an inclusive end; Prep queries use an exclusive end. Start the API, then run the query command in another terminal.

npm run sync -- --to 1002npm run serve# In another terminalnpm run query

Use npm run follow for ongoing indexing. Restart resumes your persisted checkpoint. Keep tokens server-side, and use a fresh project namespace when changing schema or handler identity.

Explore before you integrate.

The console keeps source coverage, application progress, and query results visible.

Open AppRead the operations guide