1
1
# Firebase Javascript SDK
2
2
3
3
<!-- BADGES -->
4
+
4
5
[ ![ Build Status] ( https://travis-ci.org/firebase/firebase-js-sdk.svg?branch=master )] ( https://travis-ci.org/firebase/firebase-js-sdk )
5
6
[ ![ Build Status] ( https://saucelabs.com/buildstatus/firebase-oss )] ( https://saucelabs.com/u/firebase-oss )
7
+
6
8
<!-- END BADGES -->
7
9
8
10
The Firebase JavaScript SDK implements the client-side libraries used by
@@ -36,7 +38,7 @@ or [`N`](https://github.com/tj/n) to install and manage multiple node versions_
36
38
37
39
In addition to Node.js we use ` yarn ` to facilitate multi package development.
38
40
39
- To install ` yarn ` follow the instructions listed on their website:
41
+ To install ` yarn ` follow the instructions listed on their website:
40
42
https://yarnpkg.com/en/docs/install
41
43
42
44
#### Java
@@ -85,16 +87,17 @@ them below.
85
87
86
88
#### Authentication Support
87
89
88
- Visit the authentication config in your project and enable the ` Anonymous `
90
+ Visit the authentication config in your project and enable the ` Anonymous `
89
91
sign-in provider to complete your project config.
90
92
91
93
#### Automated Setup
92
94
93
- The remainder of the test setup can be done by running the following command at
95
+ The remainder of the test setup can be done by running the following commands at
94
96
the root of the package:
95
97
96
98
``` bash
97
99
yarn test:setup
100
+ yarn build
98
101
```
99
102
100
103
### Running the tests
@@ -115,13 +118,13 @@ an individual package directory.
115
118
### Introduction
116
119
117
120
The Firebase JS SDK is built with a series of individual packages that are all
118
- contained in this repository. Development is coordinated via [ yarn
119
- workspaces] ( https://yarnpkg.com/blog/2017/08/02/introducing-workspaces/ ) and
121
+ contained in this repository. Development is coordinated via [ yarn
122
+ workspaces] ( https://yarnpkg.com/blog/2017/08/02/introducing-workspaces/ ) and
120
123
[ Lerna] ( https://lernajs.io/ ) (a monorepo management tool).
121
124
122
125
Each package in the ` packages ` directory, constitute a piece of our
123
126
implementation. The SDK is built via a combination of all of these packages
124
- which are published under the [ ` firebase `
127
+ which are published under the [ ` firebase `
125
128
scope] ( https://www.npmjs.com/search?q=scope%3Afirebase ) on NPM.
126
129
127
130
### Helper Scripts
@@ -139,7 +142,7 @@ yarn dev
139
142
140
143
### Prepush Hooks
141
144
142
- As part of this repo, we use the NPM package [ ` husky ` ] ( https://npm.im/husky ) to
145
+ As part of this repo, we use the NPM package [ ` husky ` ] ( https://npm.im/husky ) to
143
146
implement git hooks. We leverage the prepush hook to do two things:
144
147
145
148
- Automated code styling (using [ ` prettier ` ] ( https://npm.im/prettier ) )
0 commit comments