Basic Tanstack Query example

This is an example TanStack application developed using ElectricSQL for read path sync, together with Tanstack Query for local writes with optimistic state.

See the Electric <> Tanstack integration docs for more context and a video of the example running here.

Setup

This example is part of the ElectricSQL monorepo and is designed to be built and run as part of the pnpm workspace defined in ../../pnpm-workspace.yaml.

Navigate to the root directory of the monorepo, e.g.:

cd ../../

Install and build all of the workspace packages and examples:

pnpm install
pnpm run -r build

Navigate back to this directory:

cd examples/tanstack

Start the example backend services using Docker Compose:

pnpm backend:up

Note that this always stops and deletes the volumes mounted by any other example backend containers that are running or have been run before. This ensures that the example always starts with a clean database and clean disk.

Now start the dev server:

pnpm dev

When you're done, stop the backend services using:

pnpm backend:down