Before you can start working on the Firebase JS SDK, you need to have Node.js
8.0.0 or greater installed on your machine.
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:
You can verify your setup by running the following commands in your terminal:
$ node -v $ yarn -v
Your Node.js version should be
8.0.0 or greater and your
yarn version should
1.0.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:
A production project is required to test the Firebase JS SDK. You can create a new project by visiting the Firebase Console.
Most of the test setup can be done by running the following command at the root of the package:
This is the only piece of config that must be done manually. Visit the
authentication config in your project and enable the
provider to complete your project config.
Each of the directories in the
integration directory as well as the
directory have their own test suites. These can be run altogether 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 individaul package directory.
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 indiviual 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:
As part of this repo, we use the NPM package
implement git hooks. We leverage the prepush hook to do two things: