Files
Guido D'Orsi 33cfc4cc25 chore: format
2025-08-14 17:27:44 +02:00
..
2025-08-14 17:27:44 +02:00

Chat example with Jazz and Vue

Getting started

You can either

  1. Clone the jazz repository, and run the app within the monorepo.
  2. Or create a new Jazz project using this example as a template.

Using the example as a template

Create a new Jazz project, and use this example as a template.

npx create-jazz-app@latest chat-vue-app --example community-chat-vue

Go to the new project directory.

cd chat-vue-app

Run the dev server.

npm run dev

Using the monorepo

This requires pnpm to be installed, see https://pnpm.io/installation.

Clone the jazz repository.

git clone https://github.com/garden-co/jazz.git

Install and build dependencies.

pnpm i && npx turbo build

Go to the example directory.

cd jazz/examples/community-chat-vue/

Start the dev server.

pnpm dev

Open http://localhost:5173 with your browser to see the result.

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 Cloud (wss://cloud.jazz.tools) - so cross-device use, invites and collaboration should just work.

You can also run a local sync server by running npx jazz-run sync, and setting the sync parameter of JazzProvider in ./src/main.ts to { peer: "ws://localhost:4200" }.