Edit this page
A guide on getting started and using Firebase JS SDK and React Native Firebase library.
Edit this page
Firebase is a Backend-as-a-Service (BaaS) app development platform that provides hosted backend services such as real-time database, cloud storage, authentication, crash reporting, analytics, and so on. It is built on Google's infrastructure and scales automatically.
There are two different ways you can use Firebase in your projects:
React Native supports both the JS SDK and the native SDK. The following sections will guide you through when to use which SDK and all the configuration steps required to use Firebase in your Expo projects.
Before proceeding, make sure that you have created a new Firebase project or have an existing one using the Firebase console.
The Firebase JS SDK is a JavaScript library that allows you to interact with Firebase services in your project. It supports services such as Authentication, Firestore, Realtime Database, and Storage in a React Native app.
You can consider using the Firebase JS SDK when you:
Firebase JS SDK does not support all services for mobile apps. Some of these services are Analytics, Dynamic Links and Crashlytics. See the React Native Firebase section if you want to use these services.
The following sub-sections use firebase@9.x.x
. Expo SDK does not enforce or recommend any specific version of Firebase to use in your app.
If you are using an older version of the firebase library in your project, you may have to adapt the code examples to match the version that you are using with the help of the Firebase JS SDK documentation.
1
After you have created your Expo project, you can install the Firebase JS SDK using the following command:
-
npx expo install firebase
2
To initialize the Firebase instance in your Expo project, you must create a config object and pass it to the initializeApp()
method imported from the firebase/app
module.
The config object requires an API key and other unique identifiers. To obtain these values, you will have to register a web app in your Firebase project. You can find these instructions in the Firebase documentation.
After you have the API key and other identifiers, you can paste the following code snippet by creating a new firebaseConfig.js file in your project's root directory or any other directory where you keep the configuration files.
import { initializeApp } from 'firebase/app';
// Optionally import the services that you want to use
// import {...} from "firebase/auth";
// import {...} from "firebase/database";
// import {...} from "firebase/firestore";
// import {...} from "firebase/functions";
// import {...} from "firebase/storage";
// Initialize Firebase
const firebaseConfig = {
apiKey: 'api-key',
authDomain: 'project-id.firebaseapp.com',
databaseURL: 'https://project-id.firebaseio.com',
projectId: 'project-id',
storageBucket: 'project-id.appspot.com',
messagingSenderId: 'sender-id',
appId: 'app-id',
measurementId: 'G-measurement-id',
};
const app = initializeApp(firebaseConfig);
// For more information on how to access Firebase in your project,
// see the Firebase documentation: https://firebase.google.com/docs/web/setup#access-firebase
You do not have to install other plugins or configurations to use Firebase JS SDK.
Firebase version 9 and above provide a modular API. You can directly import any service you want to use from the firebase
package. For example, if you want to use an authentication service in your project, you can import the auth
module from the firebase/auth
package.
Troubleshooting tip: If you encounter issues related to authentication persistence with Firebase JS SDK, see the guide for setting up persistence to keep users logged in between reloads.
3
If you are using Firebase version9.7.x
and above, you need to add the following configuration to a metro.config.js file to make sure that the Firebase JS SDK is bundled correctly.
Expo CLI uses Metro to bundle your JavaScript code and assets, and add support for more file extensions.
Start by generating the template file metro.config.js in your project's root directory using the following command:
-
npx expo customize metro.config.js
Then, update the file with the following configuration:
const { getDefaultConfig } = require('@expo/metro-config');
const defaultConfig = getDefaultConfig(__dirname);
defaultConfig.resolver.sourceExts.push('cjs');
module.exports = defaultConfig;
For more information on how to use Authentication in your project, see Firebase documentation.
For more information on how to use Firestore database in your project, see Firebase documentation.
For more information on how to use Realtime Database in your project, see Firebase documentation.
For more information on how to use Storage, see Firebase documentation.
Learn how to use Firebase Storage in an Expo project with our example.
For more information about managing API Key and unique identifiers in a Firebase project.
For more information on migrating from expo-firebase-analytics or expo-firebase-recaptcha packages to React Native Firebase.
React Native Firebase provides access to native code by wrapping the native SDKs for Android and iOS into a JavaScript API.
Each Firebase service is available as a module that can be added as a dependency to your project. For example, the auth
module provides access to the Firebase Authentication service.
You can consider using React Native Firebase when:
If your project has been previously using expo-firebase-analytics
and expo-firebase-recaptcha
packages, you can migrate to the React Native Firebase library. For more information, see Firebase migration guide.
React Native Firebase requires custom native code and cannot be used with Expo Go.
1
Since React Native Firebase requires custom native code, you need to install the expo-dev-client
library in your project.
It also allows configuring any native code required by React Native Firebase using Config plugins without writing native code yourself.
To install expo-dev-client
, run the following command in your project:
-
npx expo install expo-dev-client
2
To use React Native Firebase, it is necessary to install the @react-native-firebase/app
module. This module provides the core functionality for all other modules.
It also adds custom native code in your project using a config plugin. You can install it using the following command:
-
npx expo install @react-native-firebase/app
At this point, you must follow the instructions from React Native Firebase documentation as it covers all the steps required to configure your project with the library.
Once you have configured the React Native Firebase library in your project, come back to this guide to learn how to run your project in the next step.
3
If you are using EAS Build, you can create and install a development build on your devices. You do not need to run the project locally before creating a development build. For more information on creating a development build, see the section on installing a development build.
If you want to run the project locally, you need both Android Studio and Xcode installed and configured on your machine. See Local app development guide for more information.
If a particular React Native Firebase module requires custom native configuration steps, you must add it as a plugin
to app config file. Then, to run the project locally, run the npx expo prebuild --clean
command to apply the native changes before the npx expo run
commands.
After configuring React Native Firebase library, you can use any module it provides in your Expo project.
For more information to install and use a certain module from React Native Firebase, we recommend you to check their documentation.