Skip to content

Add JVM support, feature states polish #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 10, 2025
Merged

Add JVM support, feature states polish #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0263ab2
Add JVM support, feature states polish
benitav Jan 10, 2025
c592916
chore: add desktop
DominicGBauer Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions client-sdk-references/kotlin-multiplatform.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebarTitle: Overview
</Card>
<Card title="Source Code" icon="github" href="https://github.com/powersync-ja/powersync-kotlin/">
Refer to the powersync-kotlin repo on GitHub.
</Card>
</Card>
<Card title="API Reference (Coming soon)" icon="book" href="">
A full API Reference for this SDK is not yet available. This is planned for the stable release.
</Card>
Expand All @@ -19,7 +19,7 @@ sidebarTitle: Overview
</CardGroup>

<Note>
The PowerSync Swift SDK is currently in a beta release. It is suitable for production use at this stage given you've tested your use cases extensively. Breaking changes are unlikely to occur.
This SDK is currently in a [**beta** release](/resources/feature-status). It is suitable for production use provided you've tested your specific use cases.
</Note>

### SDK Features
Expand All @@ -31,12 +31,18 @@ sidebarTitle: Overview
* Enables subscription to queries for receiving live updates.
* Eliminates the need for client-side database migrations as these are managed automatically.

Supported targets: Android and iOS.
Supported targets: Android, iOS and Desktop.

## Installation

See the [SDK's README](https://github.com/powersync-ja/powersync-kotlin?tab=readme-ov-file#installation) for installation instructions.

<Info>
**JVM compatibility for Desktop**
* The following platforms are supported: Linux AArch64, Linux X64, MacOS AArch64, MacOS X64, Windows X64.
* See this [example build.gradle file](https://github.com/powersync-ja/powersync-kotlin/blob/main/demos/hello-powersync/composeApp/build.gradle.kts) for the relevant JVM config.
</Info>

## Getting Started

Before implementing the PowerSync SDK in your project, make sure you have completed these steps:
Expand Down Expand Up @@ -112,7 +118,7 @@ import com.powersync.PowerSyncDatabase

// Android
val driverFactory = DatabaseDriverFactory(this)
// iOS
// iOS & Desktop
val driverFactory = DatabaseDriverFactory()
```

Expand Down
2 changes: 1 addition & 1 deletion client-sdk-references/swift.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ sidebarTitle: "Overview"
</CardGroup>

<Note>
The PowerSync Swift SDK is currently in a beta release. It is suitable for production use at this stage given you've tested your use cases extensively. Breaking changes are unlikely to occur.
This SDK is currently in a [**beta** release](/resources/feature-status). It is suitable for production use provided you've tested your specific use cases.
</Note>

## Kotlin Multiplatform -> Native Swift SDK
Expand Down
2 changes: 1 addition & 1 deletion installation/database-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ Notably, some "serverless Postgres" providers do not support logical replication

### Status of MongoDB support in PowerSync

In PowerSync nomenclature, Beta means the package is ready to be used for production given you have adequately tested your use case. We typically don't make any breaking API changes when moving from Beta to V1.
In PowerSync nomenclature, Beta means the package is ready to be used for production given you have adequately tested your use case. We typically don't make any breaking API changes when moving from Beta to V1 (learn more about feature states [here](/resources/feature-status)).

#### Alpha (Completed)

Expand Down
4 changes: 2 additions & 2 deletions resources/demo-apps-example-projects.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@ Example projects are listed under backend they use, but you can easily wire up y
#### Supabase Backend:

* [Minimal 'Hello PowerSync' App](https://github.com/powersync-ja/powersync-kotlin/tree/main/demos/hello-powersync)

* Includes Android, iOS and Desktop (JVM) targets.
* [To-Do List App](https://github.com/powersync-ja/powersync-kotlin/tree/main/demos/supabase-todolist)

* Includes Android, iOS targets.
* [To-Do List App as a native Android application](https://github.com/powersync-ja/powersync-kotlin/tree/main/demos/android-supabase-todolist)

</Accordion>
Expand Down
Loading