electric-sql

ElectricSQL TypeScript Client

ElectricSQL is a local-first sync layer for modern apps. Use it to build reactive, realtime, local-first apps using standard open source Postgres and SQLite.

The ElectricSQL TypeScript Client is the main ElectricSQL client library. It provides a type-safe database client autogenerated from your database schema and APIs for Shape-based sync and live queries as well as SQLite driver adapters and frontend framework integrations.

See the:

• Documentation
• Introduction
• Quickstart

And see the Drivers documentation for information on how to use for web, mobile, and server applications including wa-sqlite, React Native, Expo and NodeJS.

Install

Using yarn:

yarn add electric-sql

Or using npm:

npm install --save electric-sql

Usage

See the Quickstart and the Usage guide.

Issues

Please raise any bugs, issues and feature requests on GitHub Issues.

Contributing

See the Community Guidelines including the Guide to Contributing and Contributor License Agreement.

Support

We have an open community Discord. If you’re interested in the project, please come and say hello and let us know if you have any questions or need any help or support getting things running.