README.md

PowerSync + Supabase Android Demo: Todo List App

This is a simple to-do list application demonstrating the use of the Kotlin Multiplatform SDK's Android package in an Android Kotlin project with Supabase.

Set up your Supabase and PowerSync project

To run this demo, you need a Supabase and PowerSync project. Detailed instructions for integrating PowerSync with Supabase can be found in the integration guide.

Follow this guide to:

1. Create and configure a Supabase project.
2. Create a new PowerSync instance, connecting to the database of the Supabase project. See instructions here.
3. Deploy Sync Streams.

Sync Streams Configuration

This demo uses Sync Streams with auto-subscribed streams to sync data. Deploy the following configuration:

config:
  edition: 3

streams:
  all_lists:
    priority: 1
    auto_subscribe: true
    query: SELECT * FROM lists WHERE owner_id = auth.user_id()

  list_items:
    auto_subscribe: true
    query: SELECT todos.* FROM todos INNER JOIN lists ON todos.list_id = lists.id WHERE lists.owner_id = auth.user_id()```

Giving lists a higher priority allows updates to be synced before all items have been received.

Configure project in Android Studio

1. Clone this repo: git clone https://github.com/powersync-ja/powersync-kotlin.git
2. Open powersync-kotlin/ in Android Studio.
3. Sync the project with Gradle (this should happen automatically, or choose File > Sync project with Gradle Files).
4. Insert your Supabase project URL, Supabase Anon Key, and PowerSync instance URL into the demos/android-supabase-todolist/local.properties file:

# local.properties
sdk.dir=/path/to/android/sdk

# Enter your PowerSync instance URL
POWERSYNC_URL=https://foo.powersync.journeyapps.com
# Enter your Supabase project's URL and public anon key (Project settings > API)
SUPABASE_URL=https://foo.supabase.co
SUPABASE_ANON_KEY=foo

Run the app

Choose a run configuration for the Android app in Android Studio and run it.

To include PowerSync in your own Android app make sure to do the following:

1. Add jitpack as a repository to your settings.gradle.kts so that the underlying android sqlite package can be downloaded:

dependencyResolutionManagement {
    repositories {
        maven("https://jitpack.io")
        ...
    }
}

2. Add the PowerSync SDK to your project by adding the following to your build.gradle.kts file:

dependencies {
    implementation("com.powersync:core-android:$powersyncVersion")
    ...
}

If you want to use the Supabase Connector, also add the following to dependencies:

dependencies {
    implementation("com.powersync:connector-supabase:$powersyncVersion")
    ...
}