@@ -16,16 +16,17 @@ The following libraries are available for the various Firebase products.
16
16
17
17
| Service or Product | Gradle Dependency | API Coverage |
18
18
| ---------------------------------------------------------------------------------| :-------------------------------------------------------------------------------------------------------------------------------| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
19
- | [ Authentication] ( https://firebase.google.com/docs/auth ) | [ ` dev.gitlive:firebase-auth:1.12.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-auth/1.12.0/pom ) | [ ![ 80%] ( https://img.shields.io/badge/-80%25-green?style=flat-square )] ( /firebase-auth/src/commonMain/kotlin/dev/gitlive/firebase/auth/auth.kt ) |
20
- | [ Realtime Database] ( https://firebase.google.com/docs/database ) | [ ` dev.gitlive:firebase-database:1.12.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-database/1.12.0/pom ) | [ ![ 70%] ( https://img.shields.io/badge/-70%25-orange?style=flat-square )] ( /firebase-database/src/commonMain/kotlin/dev/gitlive/firebase/database/database.kt ) |
21
- | [ Cloud Firestore] ( https://firebase.google.com/docs/firestore ) | [ ` dev.gitlive:firebase-firestore:1.12.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-firestore/1.12.0/pom ) | [ ![ 60%] ( https://img.shields.io/badge/-60%25-orange?style=flat-square )] ( /firebase-firestore/src/commonMain/kotlin/dev/gitlive/firebase/firestore/firestore.kt ) |
22
- | [ Cloud Functions] ( https://firebase.google.com/docs/functions ) | [ ` dev.gitlive:firebase-functions:1.12.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-functions/1.12.0/pom ) | [ ![ 80%] ( https://img.shields.io/badge/-80%25-green?style=flat-square )] ( /firebase-functions/src/commonMain/kotlin/dev/gitlive/firebase/functions/functions.kt ) |
23
- | [ Cloud Messaging] ( https://firebase.google.com/docs/cloud-messaging ) | [ ` dev.gitlive:firebase-messaging:1.12.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-messaging/1.12.0/pom ) | [ ![ 1%] ( https://img.shields.io/badge/-0%25-lightgrey?style=flat-square )] ( /firebase-messaging/src/commonMain/kotlin/dev/gitlive/firebase/messaging/messaging.kt ) |
24
- | [ Cloud Storage] ( https://firebase.google.com/docs/storage ) | [ ` dev.gitlive:firebase-storage:1.12.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-storage/1.12.0/pom ) | [ ![ 40%] ( https://img.shields.io/badge/-40%25-orange?style=flat-square )] ( /firebase-storage/src/commonMain/kotlin/dev/gitlive/firebase/storage/storage.kt ) |
25
- | [ Installations] ( https://firebase.google.com/docs/projects/manage-installations ) | [ ` dev.gitlive:firebase-installations:1.12.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-installations/1.12.0/pom ) | [ ![ 90%] ( https://img.shields.io/badge/-90%25-green?style=flat-square )] ( /firebase-installations/src/commonMain/kotlin/dev/gitlive/firebase/installations/installations.kt ) |
26
- | [ Remote Config] ( https://firebase.google.com/docs/remote-config ) | [ ` dev.gitlive:firebase-config:1.12.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-config/1.12.0/pom ) | [ ![ 20%] ( https://img.shields.io/badge/-20%25-orange?style=flat-square )] ( /firebase-config/src/commonMain/kotlin/dev/gitlive/firebase/remoteconfig/FirebaseRemoteConfig.kt ) |
27
- | [ Performance] ( https://firebase.google.com/docs/perf-mon ) | [ ` dev.gitlive:firebase-perf:1.12.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-perf/1.12.0/pom ) | [ ![ 1%] ( https://img.shields.io/badge/-1%25-orange?style=flat-square )] ( /firebase-perf/src/commonMain/kotlin/dev/gitlive/firebase/perf/performance.kt ) |
28
- | [ Crashlytics] ( https://firebase.google.com/docs/crashlytics ) | [ ` dev.gitlive:firebase-crashlytics:1.12.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-crashlytics/1.12.0/pom ) | [ ![ 80%] ( https://img.shields.io/badge/-1%25-orange?style=flat-square )] ( /firebase-crashlytics/src/commonMain/kotlin/dev/gitlive/firebase/crashlytics/crashlytics.kt ) |
19
+ | [ Analytics] ( https://firebase.google.com/docs/analytics ) | [ ` dev.gitlive:firebase-analytics:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-analytics/1.13.0/pom ) | [ ![ 80%] ( https://img.shields.io/badge/-80%25-green?style=flat-square )] ( /firebase-auth/src/commonMain/kotlin/dev/gitlive/firebase/auth/auth.kt ) |
20
+ | [ Authentication] ( https://firebase.google.com/docs/auth ) | [ ` dev.gitlive:firebase-auth:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-auth/1.13.0/pom ) | [ ![ 80%] ( https://img.shields.io/badge/-80%25-green?style=flat-square )] ( /firebase-auth/src/commonMain/kotlin/dev/gitlive/firebase/auth/auth.kt ) |
21
+ | [ Realtime Database] ( https://firebase.google.com/docs/database ) | [ ` dev.gitlive:firebase-database:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-database/1.13.0/pom ) | [ ![ 70%] ( https://img.shields.io/badge/-70%25-orange?style=flat-square )] ( /firebase-database/src/commonMain/kotlin/dev/gitlive/firebase/database/database.kt ) |
22
+ | [ Cloud Firestore] ( https://firebase.google.com/docs/firestore ) | [ ` dev.gitlive:firebase-firestore:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-firestore/1.13.0/pom ) | [ ![ 60%] ( https://img.shields.io/badge/-60%25-orange?style=flat-square )] ( /firebase-firestore/src/commonMain/kotlin/dev/gitlive/firebase/firestore/firestore.kt ) |
23
+ | [ Cloud Functions] ( https://firebase.google.com/docs/functions ) | [ ` dev.gitlive:firebase-functions:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-functions/1.13.0/pom ) | [ ![ 80%] ( https://img.shields.io/badge/-80%25-green?style=flat-square )] ( /firebase-functions/src/commonMain/kotlin/dev/gitlive/firebase/functions/functions.kt ) |
24
+ | [ Cloud Messaging] ( https://firebase.google.com/docs/cloud-messaging ) | [ ` dev.gitlive:firebase-messaging:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-messaging/1.13.0/pom ) | [ ![ 1%] ( https://img.shields.io/badge/-0%25-lightgrey?style=flat-square )] ( /firebase-messaging/src/commonMain/kotlin/dev/gitlive/firebase/messaging/messaging.kt ) |
25
+ | [ Cloud Storage] ( https://firebase.google.com/docs/storage ) | [ ` dev.gitlive:firebase-storage:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-storage/1.13.0/pom ) | [ ![ 40%] ( https://img.shields.io/badge/-40%25-orange?style=flat-square )] ( /firebase-storage/src/commonMain/kotlin/dev/gitlive/firebase/storage/storage.kt ) |
26
+ | [ Installations] ( https://firebase.google.com/docs/projects/manage-installations ) | [ ` dev.gitlive:firebase-installations:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-installations/1.13.0/pom ) | [ ![ 90%] ( https://img.shields.io/badge/-90%25-green?style=flat-square )] ( /firebase-installations/src/commonMain/kotlin/dev/gitlive/firebase/installations/installations.kt ) |
27
+ | [ Remote Config] ( https://firebase.google.com/docs/remote-config ) | [ ` dev.gitlive:firebase-config:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-config/1.13.0/pom ) | [ ![ 20%] ( https://img.shields.io/badge/-20%25-orange?style=flat-square )] ( /firebase-config/src/commonMain/kotlin/dev/gitlive/firebase/remoteconfig/FirebaseRemoteConfig.kt ) |
28
+ | [ Performance] ( https://firebase.google.com/docs/perf-mon ) | [ ` dev.gitlive:firebase-perf:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-perf/1.13.0/pom ) | [ ![ 1%] ( https://img.shields.io/badge/-1%25-orange?style=flat-square )] ( /firebase-perf/src/commonMain/kotlin/dev/gitlive/firebase/perf/performance.kt ) |
29
+ | [ Crashlytics] ( https://firebase.google.com/docs/crashlytics ) | [ ` dev.gitlive:firebase-crashlytics:1.13.0 ` ] ( https://search.maven.org/artifact/dev.gitlive/firebase-crashlytics/1.13.0/pom ) | [ ![ 80%] ( https://img.shields.io/badge/-1%25-orange?style=flat-square )] ( /firebase-crashlytics/src/commonMain/kotlin/dev/gitlive/firebase/crashlytics/crashlytics.kt ) |
29
30
30
31
Is the Firebase library or API you need missing? [ Create an issue] ( https://github.com/GitLiveApp/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/GitLiveApp/firebase-kotlin-sdk/fork )
31
32
@@ -287,6 +288,23 @@ You can build and test the project locally.
287
288
3 . Install the GitLive plugin into IntelliJ
288
289
4 . After a gradle sync then run ` publishToMavenLocal `
289
290
291
+ ### Testing
292
+ To run the tests you can use the following gradle tasks:
293
+
294
+ ` ./gradlew connectedAndroidTest ` (an emulator needs to be running)
295
+
296
+ ` ./gradlew iosSimulatorArm64Test `
297
+
298
+ ` ./gradlew jsNodeTest `
299
+
300
+ For some tests you need to have the firebase emulator suite running. After installing them you can run the following command inside the ` test ` directory:
301
+
302
+ ` firebase emulators:start `
303
+
304
+ ### Documentation
305
+ For every publicly available class or function there needs to be documentation written in the [ KDoc syntax] ( https://kotlinlang.org/docs/kotlin-doc.html ) .
306
+ We publish a new version of the documentation after every release and can be found [ here] ( https://gitliveapp.github.io/firebase-kotlin-sdk/ )
307
+
290
308
### Compatibility with the official [ Firebase Android SDK] ( https://github.com/firebase/firebase-android-sdk )
291
309
292
310
When this project began, the official Firebase Android SDK was a pure java library and the separate Kotlin extensions (KTX) module consisted of only a few extensions providing some syntactic sugar, for example ` Firebase.firestore ` instead of ` Firebase.getInstance(), ` which we naturally copied for the Firebase Kotlin SDK.
0 commit comments