supabase-kt

A Kotlin Multiplatform Client for Supabase.

For information about supported Kotlin targets, see the corresponding module README.

Migrating from version 1.4.X to 2.0.0

Note: WASM build available: 2.0.4-wasm0

Links

Documentation

Getting started with Android and Supabase [Video]

Quickstart

Tutorial: Build a Product Management Android App with Jetpack Compose

Dokka documentation for the latest version

Troubleshooting

Installation

Available modules: gotrue-kt, postgrest-kt, functions-kt, storage-kt, realtime-kt, apollo-graphql, compose-auth, compose-auth-ui, coil-integration, imageloader-integration

dependencies {
    implementation("io.github.jan-tennert.supabase:[module]: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]")

Main Modules

Authentication (GoTrue)

Database/Postgrest

Storage

Realtime

Functions (Edge Functions)

Plugins

Apollo GraphQL integration - Creates an Apollo GraphQL Client for interacting with the Supabase API.

Compose Auth - Provides easy Native Google & Apple Auth for Compose Multiplatform targets.

Compose Auth UI - Provides UI Components for Compose Multiplatform.

Coil Integration - Provides a Coil Integration for displaying images stored in Supabase Storage.

Compose-ImageLoader Integration - Provides a Compose ImageLoader Integration for displaying images stored in Supabase Storage.

Demos

• Chat Demo (Desktop/Android/iOS/Browser)
• File Upload Demo (Desktop/Android)
• Android Native Google login & in-app OAuth (Android)
• Multi-Factor Authentication (Desktop/Android/Browser)
• Multiplatform Deep Linking (Desktop/Android)
• Groceries Store App (Android)

Need help?

• Join the Supabase Discord and create a new post with the 'Kotlin' tag under help-and-questions
• Create a discussion
• Create an issue

Videos

• Getting started with Android and Supabase by the official Supabase YouTube channel
• Getting started with Supabase on Android (by Eric Ampire)
• Supabase | Jetpack Compose | Android | 2023 (by YoursSohailYT)

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

Credits

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