Client-side Setup

The next step after configuring your database is to include the appropriate PowerSync client SDK package in your app project.

PowerSync currently supports apps built in Flutter, React Native & Expo, JS Web, and Kotlin (alpha). Please see the steps based on your type of app:

Flutter

Get started by adding the PowerSync pub.dev package to your Flutter project by running the following CLI command:

flutter pub add powersync

See the full SDK reference for further details and getting started instructions:

PowerSync is not compatible with Expo Go. PowerSync uses a native plugin and is therefore only compatible with Expo Dev Builds.

Get started by adding the PowerSync React Native NPM package to your project:

npx expo install @powersync/react-native

Some peer dependencies and polyfills are also required.

Due to the lack of good support for HTTP Streams in React Native, some polyfills are required in order to use PowerSync. PowerSync will be transitioning to a websocket based architecture in the near future.
Refer to the README for the NPM package for details.

Also see the section for additional requirements on Android and iOS.

See the full SDK reference for further details and getting started instructions:

Get started by adding the PowerSync JS Web NPM package to your project:

npm install @powersync/web

Some peer dependencies are also required.

See the full SDK reference for further details and getting started instructions:

The PowerSync Kotlin Multiplatform SDK is currently in open alpha and this section is coming soon.

For an overview of the client-side steps required to set up PowerSync in your app, continue reading the next sections.

For a walkthrough with example implementations for your platform, see the Getting Started section of the corresponding SDK reference linked above.

Last updated 4 days ago