Links

Client-side Setup

The next step after configuring your database is to include the PowerSync package in your app project.
PowerSync currently supports apps built in Flutter, React Native & Expo, and JS Web. 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

React Native & Expo

Get started by adding the PowerSync NPM package to your React Native & Expo project by running the following CLI command:
npx expo install @journeyapps/powersync-sdk-react-native
The SDK is not compatible with Expo Go — a native runtime must be built.
For plain React Native projects (not using Expo), use npm add or yarn add above instead of npx expo install
Some peer dependencies and polyfills are also required.
  • Refer to the README for the NPM package for more details.
Install our native SQLite module into your application:
npx expo install @journeyapps/react-native-quick-sqlite
Ensure the following polyfills are present in your application:
npx expo install \
react-native-fetch-api \
react-native-polyfill-globals \
react-native-url-polyfill \
text-encoding \
web-streams-polyfill \
base-64 \
react-native-get-random-values

JS Web

Get started by adding the PowerSync Web package to your project:
npm install @journeyapps/powersync-sdk-web
Some peer dependencies are also required.
  • Refer to the README for the NPM package for more details.

Next Steps

You'll then need to complete the following activities (outlined in the following sections)