You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# OP-SQLite Factory for the PowerSync React Native SDK
4
2
5
-
#PowerSync SDK for React Native
3
+
## Overview
6
4
7
-
_[PowerSync](https://www.powersync.com) is a sync engine for building local-first apps with instantly-responsive UI/UX and simplified state transfer. Syncs between SQLite on the client-side and Postgres or MongoDB on the server-side (MySQL coming soon)._
5
+
This package (`packages/powersync-op-sqlite`) enables using [OP-SQLite](https://github.com/op-engineering/op-sqlite) with PowerSync alongside the [React Native SDK](../react-native/README.md).
8
6
9
-
This package (`packages/powersync-op-sqlite`) enables using OP-SQLite with PowerSync. It is an extension of `packages/common`.
7
+
If you are not yet familiar with PowerSync, please see the [PowerSync React Native SDK](../react-native/README.md) for more information.
10
8
11
-
## Alpha release
9
+
###Alpha release
12
10
13
11
This package is currently in an alpha release. If you find a bug or issue, please open a [GitHub issue](https://github.com/powersync-ja/powersync-js/issues). Questions or feedback can be posted on our [community Discord](https://discord.gg/powersync) - we'd love to hear from you.
14
12
15
-
# Installation
13
+
##Installation
16
14
17
-
## Install Package
15
+
Follow the installation instructions for the [React Native SDK](../react-native/README.md) if you haven't yet set up PowerSync in your project. However, note that this package cannot be installed alongside `@journeyapps/react-native-quick-sqlite`. Skip the step about installing it as a peer dependency, or uninstall it if it is already installed.
16
+
17
+
### Install Package
18
18
19
19
```bash
20
20
npx expo install @powersync/op-sqlite
21
21
```
22
22
23
-
## Install Peer Dependency: SQLite
23
+
###Install Peer Dependency:
24
24
25
25
This SDK currently requires `@op-engineering/op-sqlite` as a peer dependency.
26
26
@@ -30,8 +30,6 @@ Install it in your app with:
30
30
npx expo install @op-engineering/op-sqlite
31
31
```
32
32
33
-
**Note**: This package cannot be installed alongside `@journeyapps/react-native-quick-sqlite`. Please ensure you do **not** install both packages at the same time.
34
-
35
33
## Usage
36
34
37
35
```typescript
@@ -45,7 +43,7 @@ const factory = new OPSqliteOpenFactory({
This package uses native libraries. Create native Android and iOS projects (if not created already) by running:
51
49
@@ -54,25 +52,3 @@ npx expo run:android
54
52
# OR
55
53
npx expo run:ios
56
54
```
57
-
58
-
# Getting Started
59
-
60
-
Our [SDK reference](https://docs.powersync.com/client-sdk-references/react-native-and-expo) contains everything you need to know to get started implementing PowerSync in your project.
61
-
62
-
# Changelog
63
-
64
-
A changelog for this SDK is available [here](https://releases.powersync.com/announcements/react-native-client-sdk).
65
-
66
-
# API Reference
67
-
68
-
The full API reference for this SDK can be found [here](https://powersync-ja.github.io/powersync-js/react-native-sdk).
69
-
70
-
# Examples
71
-
72
-
For example projects built with PowerSync and React Native, see our [Demo Apps / Example Projects](https://docs.powersync.com/resources/demo-apps-example-projects#react-native-and-expo) gallery. Most of these projects can also be found in the [`demos/`](../demos/) directory.
73
-
74
-
# Found a bug or need help?
75
-
76
-
- Join our [Discord server](https://discord.gg/powersync) where you can browse topics from our community, ask questions, share feedback, or just say hello :)
77
-
- Please open a [GitHub issue](https://github.com/powersync-ja/powersync-js/issues) when you come across a bug.
78
-
- Have feedback or an idea? [Submit an idea](https://roadmap.powersync.com/tabs/5-roadmap/submit-idea) via our public roadmap or [schedule a chat](https://calendly.com/powersync-product/powersync-chat) with someone from our product team.
This SDK currently requires `@journeyapps/react-native-quick-sqlite` as a peer dependency.
23
+
By default, this SDK requires `@journeyapps/react-native-quick-sqlite` as a peer dependency. Alternatively, you can install OP-SQLite from the [PowerSync OP-SQLite package](../powersync-op-sqlite/README.md) (currently in alpha).
0 commit comments