Installation

To use ElectricSQL, you need to

1. have NodeJS and either Docker or Elixir
2. have a Postgres database with logical replication enabled
3. run the Electric sync service
4. generate the TypeScript client

note

If you're looking for a quick way to get up and running, you can use the create-electric-app starter template described in the Quickstart.

Prerequisites

NodeJS and either Docker or Elixir.

Postgres

With logical replication enabled.

Sync service

Run the Electric service that manages active-active replication.

TypeScript client

Generate a local database client as part of your build process.

Need help?

If you have any questions or problems getting setup let us know on Discord.