Upgrade to Version 9
Version 9 has a redesigned API that supports tree-shaking. Read the Upgrade Guide to learn more.
Please see Environment Support.
SDK Dev Workflow
Before you can start working on the Firebase JS SDK, you need to have Node.js
installed on your machine. The currently supported versions are
10.15.0 or greater.
To download Node.js visit https://nodejs.org/en/download/.
In addition to Node.js we use
yarn to facilitate multi package development.
yarn follow the instructions listed on their website:
The closure compiler requires a modern Java installation. Java 8+ should be installed: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
You can verify your setup by running the following commands in your terminal:
$ node -v $ yarn -v $ java -version
Your Node.js version should be
10.15.0 or greater, your
yarn version should
1.0.0 or greater, and your
java version should be
1.8.0 or greater.
NOTE: We will update the documentation as new versions are required, however for continuing development on the SDK, staying up to date on the stable versions of these packages is advised
Once you have Node.js and
yarn installed on your machine and have validated
that you are running the proper version, you can set up the development environment
by running the following at the root of the SDK:
Once you have installed all the dependencies, you can build the entire SDK by running the following command the root of the SDK:
$ yarn build
Testing the SDK
A production project is required to test the Firebase JS SDK. You can create a new project by visiting the Firebase Console.
Web App Setup
Visit the "Project Overview" and select "Add app" under your project name. Register the app with a nickname and click through the remaining steps. Without performing this step, you will encounter the error in the test setup:
FirebaseError: There are no WEB apps associated with this Firebase project
Firestore Database Setup
Visit the "Firestore Database" section of the console and create a Cloud Firestore database. When prompted to select the set of initial security rules, select any option (e.g. "Start in Production Mode") since these permission settings will be overwritten below.
Realtime Database Setup
Visit the "Realtime Database" section of the console and create a realtime database. When prompted to select the set of initial security rules, select any option (e.g. "Start in Production Mode") since these permission settings will be overwritten below.
Visit the authentication config in your project and enable the
sign-in provider to complete your project config.
The tests need to be configured to use the Firebase production project that you
created in the "Test Setup" section above. To do this, run the
command, as follows:
# Select the Firebase project via the text-based UI. $ yarn test:setup # Specify the Firebase project via the command-line arguments. $ yarn test:setup --projectId=<test_firebase_project_id>
If you see an error like
HTTP Error: 404, Project '<test_firebase_project_id>' does not exist.
then make sure that you have created the database as specified in the "Firestore Database Setup" section above.
Running the tests
Each of the directories in the
integration directory as well as the
directory have their own test suites. You will need to build the SDK before
running tests. Test suites can be run all together by running the following
command at the root of the package:
$ yarn test
In addition, you can run any of the tests individually by running
yarn test in
an individual package directory.
Building the SDK
Each package in the
packages directory, constitute a piece of our
implementation. The SDK is built via a combination of all of these packages
which are published under the
scope on NPM.
Each package in the
packages directory exposes a
dev script. This script
will set up a watcher for development on the individual piece of the SDK. In
addition, there is a top level
dev script that can be run to start all of the
watch tasks as well as a sandbox server.
You can run the dev script by running the following at the root of the package:
$ yarn dev
As part of this repo, we use the NPM package
implement git hooks. We leverage the prepush hook to do two things:
- Automated code styling (using
- Automated LICENSE header insertion
Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs