Google's realtime app platform (Database, Authentication, Configuration, Notifications) firebase.google.com
Requires NativeScript 2.3.0 or up. So
npm install -g nativescript
like a boss if you need to!
For readability the supported features have been moved to their own README's:
- Setup and troubleshooting (continue reading below)
- Realtime Database
- Authentication
- Remote Config
- Cloud Messaging
- Storage
- Crash Reporting
- Analytics
Head on over to https://console.firebase.google.com/ and sign up for a free account.
Your first 'Firebase' will be automatically created and made available via an URL like https://n-plugin-test.firebaseio.com
.
Open your Firebase project at the Google console and click 'Add app' to add an iOS and / or Android app. Follow the steps (make sure the bundle id is the same as your nativescript.id
in package.json
and you'll be able to download:
-
iOS:
GoogleService-Info.plist
which you'll add to your NativeScript project atapp/App_Resources/iOS/GoogleService-Info.plist
-
Android:
google-services.json
which you'll add to your NativeScript project atapp/App_Resources/Android/google-services.json
If you rather watch a video explaining the steps then check out this step-by-step guide - you'll also learn how to
add iOS and Android support to the Firebase console and how to integrate anonymous authentication:
From the command prompt go to your app's root folder and execute:
tns plugin add nativescript-plugin-firebase
This will guide you through installing additional components. Check the doc links above to see what's what. You can always change your choices later.
If you choose to save your config during the installation, the supported options may be saved in the firebase.nativescript.json
at the root of your app.
This is to ensure your app may roundtrip source control and installation on CI won't run the questionary during install.
You can reconfigure the plugin by going to the node_modules/nativescript-plugin-firebase
and running npm run config
.
You can also change the configuration by deleting the firebase.nativescript.json
and reinstalling the plugin.
Install the latest packages 'Google Play Services' and 'Google Repository' in your Android SDK Manager
The plugin will default to version 9.8.0+ of the Android play-services-base
SDK.
If you need to change the version (to for instance the latest version), you can add a project ext property googlePlayServicesVersion
like so:
// /app/App_Resources/Android/app.gradle
project.ext {
googlePlayServicesVersion = "+"
}
If you want a quickstart, clone our demo app.
We need to do some wiring when your app starts, so open app.js
and add this before application.start();
:
var firebase = require("nativescript-plugin-firebase");
firebase.init({
// Optionally pass in properties for database, authentication and cloud messaging,
// see their respective docs.
}).then(
function (instance) {
console.log("firebase.init done");
},
function (error) {
console.log("firebase.init error: " + error);
}
);
import firebase = require("nativescript-plugin-firebase");
firebase.init({
// Optionally pass in properties for database, authentication and cloud messaging,
// see their respective docs.
}).then(
(instance) => {
console.log("firebase.init done");
},
(error) => {
console.log("firebase.init error: " + error);
}
);
On the simulator you may see this message if you have more than one app with the Firebase SDK ever installed:
[FirebaseDatabase] Authentication failed: invalid_token (Invalid claim 'aud' in auth token.)
or
[FirebaseDatabase] Authentication failed: invalid_token (audience was project 'firegroceries-904d0' but should have been project 'your-firebase-project')
This is a known issue in the Firebase SDK. I always use a real device to avoid this problem, but you can pass an 'iOSEmulatorFlush' option to init.
firebase.init({
// Optionally pass in properties for database, authentication and cloud messaging,
// see their respective docs and 'iOSEmulatorFlush' to flush token before init.
iOSEmulatorFlush: true
}).then()
If you see an error like Unable to satisfy the following requirements: Firebase (~> 3.3.0) required by Podfile
,
then check issue 98 which perfectly explains how to update your local Pod spec repo, or first try
to tns platform remove ios && tns platform add ios
.
Running pod repo update
on the command line will make sure you have the latest Podspec,
so when the plugin updates and a newer Firebase version can't be found, try that first.
You can use the awesome Genymotion emulator but you'll need to install Google Play Services on it or you'll run into errors during authentication.
com.android.dex.DexIndexOverflowException: method ID not in..
Congrats, you ran into this issue
which can be solved by adding multiDexEnabled true
to your app/App_Resources/Android/app.gradle
so it becomes something like this:
android {
defaultConfig {
applicationId = "__PACKAGE__"
multiDexEnabled true
generatedDensities = []
}
aaptOptions {
additionalParameters "--no-version-vectors"
}
}
Increase the Java Max Heap Size like this (the bit at the end):
android {
defaultConfig {
applicationId = "__PACKAGE__"
multiDexEnabled true
generatedDensities = []
}
aaptOptions {
additionalParameters "--no-version-vectors"
}
dexOptions {
javaMaxHeapSize "4g"
}
}
Another possible error is "FirebaseApp with name [DEFAULT] doesn't exist." which will be solved by
placing google-services.json
to platforms/android/google-services.json
(see above), and making
the changes to build.gradle
which are mentioned above as well.
And there's this one: "Could not find com.google.firebase:firebase-auth:9.4.0". That means
making sure you have the latest Google Repository
bits installed.
Just run android
from a command prompt and install any pending updates.
Also, an error like "Could not find com.google.firebase:firebase-core:9.0.0" can be caused by having more than one version of the Android SDK installed. Make sure ANDROID_HOME is set to the Android SDK directory that is being updated otherwise it will seem as though your updates have no effect.
Update your Android bits like the issue above and reinstall the android platform in your project.
The starting point for this plugin was this great Gist by John Bristowe.