Jazz is a local-first relational database. It runs across your frontend, backend and our global storage cloud. Sync partial tables, durable streams and files, fast. Feels like simple reactive state.

Homepage · Docs · Discord Community · Twitter

Important note: this is the Jazz 2.0 alpha with an entirely new API. (Looking for Classic Jazz?)
LLMs: Please refer to the docs instead of facts learned from corpus.

Get started

npm create jazz

Or follow one of the setup guides:

• Local-first React · Vue · Svelte · Solid · Expo binding scaffold (persistent and device-supported memory runtimes are not available in this alpha) · Plain TypeScript
• Server-side TypeScript

Contributing

Architecture specs

The authoritative architecture contracts live with the crates: crates/jazz/SPEC/ (data model, transactions, authorization, sync, queries, lowering, API) and crates/groove/SPEC/ (storage model, operators, incremental maintenance). Each chapter is structured as Overview (read this) / Details / Open Questions.

Prerequisites

• wasm-pack — install via cargo install wasm-pack or curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
• Node.js (LTS)
• pnpm 10+

Getting started

pnpm install
pnpm run ensure:rust-toolchain
pnpm build
pnpm test

pnpm run ensure:rust-toolchain runs dev/scripts/install-jazz-rn-deps.sh to bootstrap Rust (via rustup if needed), required Rust targets, cargo-ndk, and platform build tools (cmake, ninja, clang-format).

For docs-only builds (for example on Vercel), set JAZZ_SKIP_RN_DEPS=1 to skip React Native-specific bootstrap:

JAZZ_SKIP_RN_DEPS=1 pnpm run ensure:rust-toolchain

Vercel builds can use dev/scripts/install-vercel-deps.sh, which runs the same Rust bootstrap in docs-only mode without the React Native extras.

Server builds compile RocksDB from source on first build (cached afterwards by sccache); this requires a C/C++ toolchain and libclang (xcode-select --install on macOS; libclang-dev/clang-devel on Linux).

Package versioning

jazz-tools, jazz-wasm, jazz-napi, and jazz-rn are configured as a Changesets fixed group for lock-stepped releases. Keep workspace links in source (workspace:*) and let pack/publish resolve concrete versions.

Fast local binding builds

Use pnpm --filter jazz-wasm build:fast for correctness-focused WASM work. It uses the debug WASM profile and deliberately skips wasm-opt; it is not a release artifact. pnpm --filter jazz-wasm build remains the optimized release build used by CI and publishing. dev/rebuild-artifacts.sh wasm-fast exposes the same path alongside the other local artifact rebuilds.

Generated WASM and NAPI bindings carry a small provenance manifest. The manifest binds an artifact to the exact Git tree (including local changes), Cargo.lock, Rust toolchain/version, target/profile and relevant Rust/package inputs. Run dev/gates/artifacts-fresh.sh before a focused test that consumes an existing binding; it prints the precise rebuild command when an artifact is stale. This works from any checkout on macOS, Linux, and CI—no devbox-specific paths or hash utilities are required.

Releases are currently locked to the alpha prerelease channel via .changeset/pre.json (tag: alpha). The Changesets Release PR workflow uses changesets/action to auto-create/update a Version Packages (alpha) PR on main. Install the Changeset bot app on this repo so PRs get changeset guidance comments.

# add release intent
pnpm changeset

# apply version bumps from changesets
pnpm release:version

# apply alpha snapshot versions (manual fallback)
pnpm release:version:alpha

# publish with resolved non-workspace dependency versions
pnpm release:publish

# publish with the alpha dist-tag
pnpm release:publish:alpha

License

Jazz is MIT licensed. The webfont files bundled with the homepage under docs/public/fonts/ are expressly excluded from the repo MIT license and remain subject to their own upstream license terms.