Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/supabase-community/supabase-kt
A Kotlin Multiplatform Client for Supabase.
https://github.com/supabase-community/supabase-kt
android auth authentication community compose compose-multiplatform jetpack-compose kotlin kotlin-android kotlin-js kotlin-multiplatform kotlin-native postgres supabase
Last synced: about 2 months ago
JSON representation
A Kotlin Multiplatform Client for Supabase.
- Host: GitHub
- URL: https://github.com/supabase-community/supabase-kt
- Owner: supabase-community
- License: mit
- Created: 2022-05-22T14:31:33.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-01T10:16:05.000Z (about 2 months ago)
- Last Synced: 2024-08-01T12:46:48.544Z (about 2 months ago)
- Topics: android, auth, authentication, community, compose, compose-multiplatform, jetpack-compose, kotlin, kotlin-android, kotlin-js, kotlin-multiplatform, kotlin-native, postgres, supabase
- Language: Kotlin
- Homepage: https://supabase.com/docs/reference/kotlin/introduction
- Size: 4.66 MB
- Stars: 344
- Watchers: 16
- Forks: 35
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- kmp-awesome - supabase-kt - KMP Client for Supabase (Libraries / 🧩 Service SDK)
- awesome-list - supabase-community/supabase-kt - A Kotlin Multiplatform Client for Supabase. (Kotlin)
README
# 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](/MIGRATION.md)
*Note: [WASM](https://github.com/supabase-community/supabase-kt/issues/86) build available: [2.4.2-wasm0](https://github.com/supabase-community/supabase-kt/releases/tag/2.4.1-wasm0)*
[](https://github.com/supabase-community/supabase-kt/releases)
[](https://central.sonatype.com/search?q=io.github.jan.supabase&smo=true)
[](http://kotlinlang.org)
[](https://kotlinlang.slack.com/archives/C06QXPC7064)
### Links
[Documentation](https://supabase.com/docs/reference/kotlin/introduction)
[Samples](#samples)
[Getting started with Android and Supabase [Video]](https://www.youtube.com/watch?v=_iXUVJ6HTHU)
[Quickstart](https://supabase.com/docs/guides/getting-started/quickstarts/kotlin)
[Tutorial: Build a Product Management Android App with Jetpack Compose](https://supabase.com/docs/guides/getting-started/tutorials/with-kotlin)
[Dokka documentation for the latest version](https://supabase-community.github.io/supabase-kt/)
[Troubleshooting](/TROUBLESHOOTING)
# Installation
### Add one or more modules to your project
**Available modules**: `gotrue-kt`, `postgrest-kt`, `functions-kt`, `storage-kt`, `realtime-kt`, `apollo-graphql`, `compose-auth`, `compose-auth-ui`, `coil-integration`, `imageloader-integration`
```kotlin
dependencies {
implementation("io.github.jan-tennert.supabase:[module]:VERSION")
}
```
If you use multiple modules, you can use the bom dependency to get the correct versions for all
modules:
```kotlin
implementation(platform("io.github.jan-tennert.supabase:bom:VERSION"))
implementation("io.github.jan-tennert.supabase:[module]")
```
### Add a Ktor Client Engine to each of your Kotlin targets
You can find a list of available engines [here](https://ktor.io/docs/http-client-engines.html).
If you plan to use the Realtime dependency, make sure to check if the engine supports WebSockets. See the [Ktor docs](https://ktor.io/docs/http-client-engines.html#limitations) for more information.
```kotlin
implementation("io.ktor:ktor-client-[engine]:VERSION")
```
Multiplatform Example
For targets: `jvm`, `android`, `js`, `ios`
```kotlin
val commonMain by getting {
dependencies {
//supabase modules
}
}
val jvmMain by getting {
dependencies {
implementation("io.ktor:ktor-client-cio:KTOR_VERSION")
}
}
val androidMain by getting {
dependsOn(jvmMain)
}
val jsMain by getting {
dependencies {
implementation("io.ktor:ktor-client-js:KTOR_VERSION")
}
}
val iosMain by getting {
dependencies {
implementation("io.ktor:ktor-client-darwin:KTOR_VERSION")
}
}
```
**Note:** It is recommended to use the same Ktor version as supabase-kt:
## Main Modules
- [Authentication](/GoTrue)
- [Database/Postgrest](/Postgrest)
- [Storage](/Storage)
- [Realtime](/Realtime)
- [Functions (Edge Functions)](/Functions)
### Plugins
- [Apollo GraphQL integration](/plugins/ApolloGraphQL) - Creates an [Apollo GraphQL Client](https://github.com/apollographql/apollo-kotlin) for interacting with the Supabase API.
- [Compose Auth](/plugins/ComposeAuth) - Provides easy Native Google & Apple Auth for Compose Multiplatform targets.
- [Compose Auth UI](/plugins/ComposeAuthUI) - Provides UI Components for Compose Multiplatform.
- [Coil Integration](/plugins/CoilIntegration) - Provides a [Coil](https://github.com/coil-kt/coil) Integration for displaying images stored in Supabase Storage.
- [Compose-ImageLoader Integration](/plugins/ImageLoaderIntegration) - Provides a [Compose ImageLoader](https://github.com/qdsfdhvh/compose-imageloader) Integration for displaying images stored in Supabase Storage.
### Miscellaneous
- [Supabase Edge Functions Kotlin](https://github.com/manriif/supabase-edge-functions-kt) - Build, serve and deploy Supabase Edge Functions with Kotlin and Gradle.
# Samples
### Multiplatform Applications
**Official Samples**
- [Chat Demo](/sample/chat-demo-mpp) *(Desktop/Android/iOS/Browser)* - A simple chat application using the Auth, Postgrest and Realtime module.
- [File Upload Demo](/sample/file-upload) *(Desktop/Android)* - A simple bulk file upload application using the Storage module.
- [Android Native Google login & in-app OAuth](https://github.com/supabase-community/supabase-kt/tree/master/demos/android-login) *(Android)* - A simple Android application showcasing Native Google login and in-app OAuth.
- [Multi-Factor Authentication](/sample/multi-factor-auth) *(Desktop/Android/Browser)* - A simple application showcasing Multi-Factor Authentication.
- [Multiplatform Deep Linking](https://github.com/supabase-community/supabase-kt/tree/master/demos/multiplatform-deeplinks) *(Desktop/Android)* - A simple application showcasing deep linking on Desktop and Android.
**Community Samples**
- [Groceries Store App](https://github.com/hieuwu/android-groceries-store) *(Android)*
### Server-side Applications
**Community Samples**
- [RESTful Service](https://github.com/hieuwu/supa-spring-kt) *(Spring Boot)*
# Need help?
- Join the [#supabase-kt](https://kotlinlang.slack.com/archives/C06QXPC7064) Kotlin Slack channel
- [Join the Supabase Discord](https://discord.supabase.com) and create a new post with the 'Kotlin' tag under `help-and-questions`
- [Create a discussion](https://github.com/supabase-community/supabase-kt/discussions/new/choose)
- [Create an issue](https://github.com/supabase-community/supabase-kt/issues/new/choose)
# Videos
- [Getting started with Android and Supabase](https://www.youtube.com/watch?v=_iXUVJ6HTHU) by the official Supabase YouTube channel
- [Getting started with Supabase on Android](https://www.youtube.com/watch?v=SGr73sWMX6w) (by [Eric Ampire](https://www.youtube.com/@eric-ampire))
- [Supabase | Jetpack Compose | Android | 2023](https://www.youtube.com/playlist?list=PL91kV_wdjTlcGQdcZzkuid094as5eUlwU) (by [YoursSohailYT](https://www.youtube.com/@YoursSohailYT))
# Contribution
Checkout the [contribution guidelines](/CONTRIBUTING.md) for more information.
# Credits
- Postgres Syntax inspired by https://github.com/supabase-community/postgrest-kt
- Plugin system inspired by ktor