website/docs/quickstart.md
Let's make a super-fast, reactive web app using <span class="no-wrap-xs">Electric with TanStack DB</span>.
<div style="max-width: 632px"></div>[!Warning] ✨ Just want to see it in action? See the app running here or fork it on StackBlitz.
You'll need Node, pnpm and Caddy installed. If you haven't used Caddy before, you'll need to install it's root certificate using:
caddy trust # may require sudo
<small><em>Why Caddy? Electric uses HTTP/2. Caddy enables HTTP/2 in local development.</em></small>
Run the starter script:
npx @electric-sql/start my-electric-app
Start the dev server:
pnpm dev
Open https://localhost:5173.
In another terminal, connect to Postgres using psql:
pnpm psql
Update the project name:
UPDATE projects SET name = 'Baz bam!';
The app updates instantly in real-time — across all users and devices.
The starter is a fully-fledged TanStack Start app with routing and auth.
You can edit the code manually. Or it has an AGENTS.md file you can load directly into your AI code editor:
claude "Read Agents.md. Sort the project page todo list alphabetically."
See the starter template README for more details.
Claim the Electric Cloud resources:
pnpm claim
Deploy the app, for example to Netlify:
pnpm deploy
Congratulations! You've shipped a super-fast, reactive web app based on real-time sync!