mirshko/jazzboard

Jazz Todo List Example

Live version: https://example-todo.jazz.tools

Installing & running the example locally

Start by checking out just the example app to a folder:

npx degit gardencmp/jazz/examples/todo jazz-example-todo
cd jazz-example-todo

(This ensures that you have the example app without git history or our multi-package monorepo)

Install dependencies:

npm install

Start the dev server:

npm run dev

Structure

• src/basicComponents: simple components to build the UI, unrelated to Jazz (uses shadcn/ui)
• src/components: helper components that do contain Jazz-specific logic, but aren't very relevant to understand the basics of Jazz and CoJSON
• src/1_types.ts, src/2_main.tsx, src/3_NewProjectForm.tsx, src/4_ProjectTodoTable.tsx: the main files for this example, see the walkthrough below

Walkthrough

Main parts

1. Defining the data model with CoJSON: src/1_types.ts

2. The top-level provider <WithJazz/> and routing: src/2_main.tsx

3. Creating a new todo project: src/3_NewProjectForm.tsx

4. Reactively rendering a todo project as a table, adding and editing tasks: src/4_ProjectTodoTable.tsx

Helpers

• (not yet explained) Creating invite links/QR codes with <InviteButton/>: src/components/InviteButton.tsx

This is the whole Todo List app!

Questions / problems / feedback

If you have feedback, let us know on Discord or open an issue or PR to fix something that seems wrong.

Configuration: sync server

By default, the example app uses Jazz Global Mesh (wss://sync.jazz.tools) - so cross-device use, invites and collaboration should just work.

You can also run a local sync server by running npx cojson-simple-sync and adding the query param ?sync=ws://localhost:4200 to the URL of the example app (for example: http://localhost:5173/?sync=ws://localhost:4200), or by setting the sync parameter of the <WithJazz> provider component in ./src/2_main.tsx.