Welcome to your ElectricSQL app!

This is a web application using ElectricSQL in the browser with wa-sqlite.

Pre-reqs

You need NodeJS >= 16.11 and Docker Compose v2. Install yarn if you don't have it already:

npm -g install yarn

Install

Install the dependencies:

yarn

Setup

Start Postgres and Electric using Docker (see running the examples for more options):

yarn backend:up
# Or `yarn backend:start` to foreground

Note that, if useful, you can connect to Postgres using:

yarn db:psql

Setup your database schema:

yarn db:migrate

Generate your type-safe client:

yarn client:generate
# or `yarn client:watch`` to re-generate whenever the DB schema changes

Run

Start your app:

yarn start

Open localhost:3001 in your web browser.

Develop

./src/Example.tsx has the main example code. For more information see the:

• Documentation
• Quickstart
• Usage guide

If you need help let us know on Discord.