|
1 |
| -<h1 align="left">Firebase Kotlin Multiplatform SDK <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/teamhubapp/firebase-kotlin-multiplatform-sdk?style=flat-square"></h1> |
| 1 | +<h1 align="left">Firebase Kotlin SDK <img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/teamhubapp/firebase-kotlin-sdk?style=flat-square"></h1> |
2 | 2 | <img align="left" width="75px" src="https://avatars2.githubusercontent.com/u/42865805?s=200&v=4">
|
3 | 3 | <b>Built and maintained with 🧡 by <a href="https://teamhub.dev">TeamHub</a></b><br/>
|
4 | 4 | <i>Real-time code collaboration inside any IDE</i><br/>
|
5 | 5 | 🔓 <a href="https://teamhub.typeform.com/to/uSS8cv">Request Early Access</a>
|
6 | 6 | <h4></h4>
|
7 | 7 |
|
8 |
| -The Firebase Kotlin Multiplatform SDK implements the client-side libraries used by applications using Firebase services. |
| 8 | +The Firebase Kotlin SDK implements the client-side libraries used by applications using Firebase services. |
9 | 9 |
|
10 |
| -It a light-weight Kotlin layer that mirrors the [Firebase Android SDK Kotlin Extensions](https://firebase.github.io/firebase-android-sdk/reference/kotlin/firebase-ktx/) but connects to the correct native Firebase SDKs for each target platform, enabling you to use Firebase directly from your common source in your Kotlin Multiplatform projects targeting iOS, Android or JS. |
| 10 | +It a light-weight Kotlin layer that mirrors the [Firebase Android SDK Kotlin Extensions](https://firebase.github.io/firebase-android-sdk/reference/kotlin/firebase-ktx/) but connects to the correct native Firebase SDK for each target platform, enabling you to use Firebase directly from your common source in multiplatform projects targeting iOS, Android or JS. |
11 | 11 |
|
12 | 12 | ## Available libraries
|
13 | 13 |
|
14 | 14 | The following libraries are available for the various Firebase products.
|
15 | 15 |
|
16 |
| - |
17 |
| -| Service or Product | Gradle Dependency | SDK Coverage | |
| 16 | +| Service or Product | Gradle Dependency | API Coverage | |
18 | 17 | | ------------------------------------------------------------------------------------ | :-----------------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
19 |
| -| [Authentication](https://firebase.google.com/docs/auth#kotlin-android) | [`dev.teamhub.firebase:firebase-auth:0.1.0`](https://mvnrepository.com/artifact/dev.teamhub.firebase/firebase-auth/0.1.0) | [](/firebase-auth/src/commonMain/kotlin/dev/teamhub/firebase/auth/auth.kt) [](/firebase-auth/src/androidMain/kotlin/dev/teamhub/firebase/auth/auth.kt) [](/firebase-auth/src/jsMain/kotlin/dev/teamhub/firebase/auth/auth.kt) [](/firebase-auth/src/iosMain/kotlin/dev/teamhub/firebase/auth/auth.kt) | |
20 |
| -| [Realtime Database](https://firebase.google.com/docs/database#kotlin-android) | [`dev.teamhub.firebase:firebase-database:0.1.0`](https://mvnrepository.com/artifact/dev.teamhub.firebase/firebase-database/0.1.0) | [](/firebase-database/src/commonMain/kotlin/dev/teamhub/firebase/auth/database.kt) [](/firebase-database/src/androidMain/kotlin/dev/teamhub/firebase/database/database.kt) [](/firebase-database/src/jsMain/kotlin/dev/teamhub/firebase/database/database.kt) [](/firebase-database/src/iosMain/kotlin/dev/teamhub/firebase/database/database.kt) | |
21 |
| -| [Cloud Firestore](https://firebase.google.com/docs/firestore#kotlin-android) | [`dev.teamhub.firebase:firebase-firestore:0.1.0`](https://mvnrepository.com/artifact/dev.teamhub.firebase/firebase-firestore/0.1.0) | [](/firebase-firestore/src/commonMain/kotlin/dev/teamhub/firebase/firestore/firestore.kt) [](/firebase-auth/src/androidMain/kotlin/dev/teamhub/firebase/firestore/firestore.kt) [](/firebase-firestore/src/jsMain/kotlin/dev/teamhub/firebase/firestore/firestore.kt) [](/firebase-firestore/src/iosMain/kotlin/dev/teamhub/firebase/firestore/firestore.kt) | |
22 |
| -| [Cloud Functions](https://firebase.google.com/docs/functions/callable#kotlin-android)| [`dev.teamhub.firebase:firebase-functions:0.1.0`](https://mvnrepository.com/artifact/dev.teamhub.firebase/firebase-functions/0.1.0) | [](/firebase-functions/src/commonMain/kotlin/dev/teamhub/firebase/functions/functions.kt) [](/firebase-functions/src/androidMain/kotlin/dev/teamhub/firebase/functions/functions.kt) [](/firebase-functions/src/jsMain/kotlin/dev/teamhub/firebase/functions/functions.kt) [](/firebase-functions/src/iosMain/kotlin/dev/teamhub/firebase/functions/functions.kt) | |
| 18 | +| [Authentication](https://firebase.google.com/docs/auth#kotlin-android) | [`dev.teamhub.firebase:firebase-auth:0.1.0`](https://mvnrepository.com/artifact/dev.teamhub.firebase/firebase-auth/0.1.0) | [](/firebase-auth/src/commonMain/kotlin/dev/teamhub/firebase/auth/auth.kt) [](/firebase-auth/src/androidMain/kotlin/dev/teamhub/firebase/auth/auth.kt) [](/firebase-auth/src/jsMain/kotlin/dev/teamhub/firebase/auth/auth.kt) [](/firebase-auth/src/iosMain/kotlin/dev/teamhub/firebase/auth/auth.kt) | |
| 19 | +| [Realtime Database](https://firebase.google.com/docs/database#kotlin-android) | [`dev.teamhub.firebase:firebase-database:0.1.0`](https://mvnrepository.com/artifact/dev.teamhub.firebase/firebase-database/0.1.0) | [](/firebase-database/src/commonMain/kotlin/dev/teamhub/firebase/auth/database.kt) [](/firebase-database/src/androidMain/kotlin/dev/teamhub/firebase/database/database.kt) [](/firebase-database/src/jsMain/kotlin/dev/teamhub/firebase/database/database.kt) [](/firebase-database/src/iosMain/kotlin/dev/teamhub/firebase/database/database.kt) | |
| 20 | +| [Cloud Firestore](https://firebase.google.com/docs/firestore#kotlin-android) | [`dev.teamhub.firebase:firebase-firestore:0.1.0`](https://mvnrepository.com/artifact/dev.teamhub.firebase/firebase-firestore/0.1.0) | [](/firebase-firestore/src/commonMain/kotlin/dev/teamhub/firebase/firestore/firestore.kt) [](/firebase-auth/src/androidMain/kotlin/dev/teamhub/firebase/firestore/firestore.kt) [](/firebase-firestore/src/jsMain/kotlin/dev/teamhub/firebase/firestore/firestore.kt) [](/firebase-firestore/src/iosMain/kotlin/dev/teamhub/firebase/firestore/firestore.kt) | |
| 21 | +| [Cloud Functions](https://firebase.google.com/docs/functions/callable#kotlin-android)| [`dev.teamhub.firebase:firebase-functions:0.1.0`](https://mvnrepository.com/artifact/dev.teamhub.firebase/firebase-functions/0.1.0) | [](/firebase-functions/src/commonMain/kotlin/dev/teamhub/firebase/functions/functions.kt) [](/firebase-functions/src/androidMain/kotlin/dev/teamhub/firebase/functions/functions.kt) [](/firebase-functions/src/jsMain/kotlin/dev/teamhub/firebase/functions/functions.kt) [](/firebase-functions/src/iosMain/kotlin/dev/teamhub/firebase/functions/functions.kt) | |
23 | 22 | | [Cloud Messaging](https://firebase.google.com/docs/messaging#kotlin-android) | [`dev.teamhub.firebase:firebase-messaging:0.1.0`](https://mvnrepository.com/artifact/dev.teamhub.firebase/firebase-messaging/0.1.0) |  |
|
24 | 23 | | [Cloud Storage](https://firebase.google.com/docs/storage#kotlin-android) | [`dev.teamhub.firebase:firebase-storage:0.1.0`](https://mvnrepository.com/artifact/dev.teamhub.firebase/firebase-storage/0.1.0) |  |
|
25 | 24 |
|
26 |
| -Is coverage missing for your usage? Create at issue to request additional coverage or be awesome [and submit a PR](https://github.com/TeamHubApp/firebase-kotlin-multiplatform-sdk/fork) |
| 25 | +Is the Firebase library or API you need missing? [Create an issue](https://github.com/TeamHubApp/firebase-kotlin-sdk/issues/new?labels=API+coverage&template=increase-api-coverage.md&title=Add+%5Bclass+name%5D.%5Bfunction+name%5D+to+%5Blibrary+name%5D+for+%5Bplatform+names%5D) to request additional API coverage or be awesome and [submit a PR](https://github.com/TeamHubApp/firebase-kotlin-sdk/fork) |
| 26 | + |
| 27 | +## Configure Firebase |
| 28 | + |
| 29 | +Since you most likely want to share your firebase configuration across platforms you should configure Firebase programatically in your common source instead of a platform-specific way (such as the Firebase configuration file on Android) |
27 | 30 |
|
28 |
| -## Getting Started |
| 31 | +You can do this as follows: |
29 | 32 |
|
30 | 33 | ```kotlin
|
31 | 34 | val options = FirebaseOptions.Builder()
|
|
0 commit comments