Need help with firebase-js-sdk?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

firebase
3.4K Stars 591 Forks Other 2.6K Commits 397 Opened issues

Description

Firebase Javascript SDK

Services available

!
?

Need anything else?

Contributors list

Firebase Javascript SDK

Build Status Build Status Version Coverage Status <!-- END BADGES -->

The Firebase JavaScript SDK implements the client-side libraries used by applications using Firebase services. This SDK is distributed via:

To get started using Firebase, see Add Firebase to your JavaScript Project.

Release Notes

Supported Environments

Please see Environment Support.

SDK Dev Workflow

Prerequisites

Node.js

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/.

NOTE: You can use a tool like

NVM
or
N
to install and manage multiple node versions

Yarn

In addition to Node.js we use

yarn
to facilitate multi package development.

To install

yarn
follow the instructions listed on their website: https://yarnpkg.com/en/docs/install

Java

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

Verify Prerequisites

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 be
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

Install Dependencies

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:
$ yarn

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

Test Setup

A production project is required to test the Firebase JS SDK. You can create a new project by visiting the Firebase Console.

Firestore Database Setup

Visit the "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.

Authentication Support

Visit the authentication config in your project and enable the

Anonymous
sign-in provider to complete your project config.

Automated Setup

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

yarn test:setup
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=

If you see an error like

HTTP Error: 404, Project '' 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
packages
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

Introduction

The Firebase JS SDK is built with a series of individual packages that are all contained in this repository. Development is coordinated via yarn workspaces and Lerna (a monorepo management tool).

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
firebase
scope
on NPM.

Helper Scripts

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

Prepush Hooks

As part of this repo, we use the NPM package

husky
to implement git hooks. We leverage the prepush hook to do two things:

  • Automated code styling (using
    prettier
    )
  • Automated LICENSE header insertion

Contributing

See Contributing for more information on contributing to the Firebase JavaScript SDK.

Big Thanks

Cross-browser Testing Platform and Open Source <3 Provided by Sauce Labs

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.