aubds / 1-supabase-kt

A Kotlin Multiplatform Client for Supabase. Can be used for apps written with jetpack compose desktop, android and web

supabase-kt

A Kotlin Multiplatform Client for Supabase. Supported targets:

• JVM
• Android
• JS (Browser)
• IOS (experimental as of 0.9.0, see PR for more information

Note: WASM planned see issue

Newest stable version:

Newest experimental version:

Links

Dokka documentation for the latest version

Wiki

Troubleshooting

Installation

dependencies {
    implementation("io.github.jan-tennert.supabase:[module e.g. functions-kt or gotrue-kt]:VERSION")

    //add ktor client engine (if you don't already have one, see https://ktor.io/docs/http-client-engines.html for all engines)
    //e.g. the CIO engine
    implementation("io.ktor:ktor-client-cio:KTOR_VERSION")
}

If you use multiple modules, you can use the bom dependency to get the correct versions for all modules:

implementation(platform("io.github.jan-tennert.supabase:bom:VERSION"))
implementation("io.github.jan-tennert.supabase:[module e.g. functions-kt or gotrue-kt]")

Getting started

Main Modules

Authentication (GoTrue)

Database/Postgrest

Storage

Realtime

Functions (Edge Functions)

Plugins

Apollo GraphQL integration

Demos

• Compose Multiplatform Chat Demo (Desktop/Android/Browser)
• File Upload Demo (Desktop/Android)

Videos

• Getting started with Supabase on Android (by Eric Ampire)

Contribution

How to contribute

1. Fork the repository
2. Create a branch
3. Make your changes
4. Submit a pull request with your new branch and add one of the following tags: fix or enhancement. You might also add one or more label when you are modifying a specific module: gotrue, realtime, functions, graphql, storage, postgrest, core

Credits

• Postgres Syntax inspired by https://github.com/supabase-community/postgrest-kt
• Plugin system inspired by ktor