Welcome to the Jazz documentation!

The Jazz docs are currently heavily work in progress, sorry about that!

Quickstart

Run the following command to create a new Jazz project from one of our example apps:

npx create-jazz-app@latest

Or set up Jazz yourself, using the following instructions for your framework of choice:

• React
• Next.js
• React Native
• Vue
• Svelte

Example apps

You can also find example apps with code most similar to what you want to build. These apps make use of different features such as auth, file upload, and more.

Sync and storage

Sync and persist your data by setting up a sync and storage infrastructure using Jazz Cloud, or do it yourself.

Collaborative values

Learn how to structure your data using collaborative values.

API Reference

Many of the packages provided are documented in the API Reference.

LLM Docs

We support the llms.txt convention for making documentation available to large language models and the applications that make use of them.

We currently have:

• /llms.txt - A overview listing of the available packages and their documentation
• /llms-full.txt - Full documentation for our packages

Get support

If you have any questions or need assistance, please don't hesitate to reach out to us on Discord. We would love to help you get started.