Skip to content

Commit 909f3e7

Browse files
author
Brian Chen
committed
update README and CONTRIBUTING to include yarn build
1 parent 2850a2c commit 909f3e7

File tree

2 files changed

+30
-7
lines changed

2 files changed

+30
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Firebase Javascript SDK
22

33
<!-- BADGES -->
4+
45
[![Build Status](https://travis-ci.org/firebase/firebase-js-sdk.svg?branch=master)](https://travis-ci.org/firebase/firebase-js-sdk)
56
[![Build Status](https://saucelabs.com/buildstatus/firebase-oss)](https://saucelabs.com/u/firebase-oss)
7+
68
<!-- END BADGES -->
79

810
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_
3638

3739
In addition to Node.js we use `yarn` to facilitate multi package development.
3840

39-
To install `yarn` follow the instructions listed on their website:
41+
To install `yarn` follow the instructions listed on their website:
4042
https://yarnpkg.com/en/docs/install
4143

4244
#### Java
@@ -85,16 +87,17 @@ them below.
8587

8688
#### Authentication Support
8789

88-
Visit the authentication config in your project and enable the `Anonymous`
90+
Visit the authentication config in your project and enable the `Anonymous`
8991
sign-in provider to complete your project config.
9092

9193
#### Automated Setup
9294

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
9496
the root of the package:
9597

9698
```bash
9799
yarn test:setup
100+
yarn build
98101
```
99102

100103
### Running the tests
@@ -115,13 +118,13 @@ an individual package directory.
115118
### Introduction
116119

117120
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
120123
[Lerna](https://lernajs.io/) (a monorepo management tool).
121124

122125
Each package in the `packages` directory, constitute a piece of our
123126
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`
125128
scope](https://www.npmjs.com/search?q=scope%3Afirebase) on NPM.
126129

127130
### Helper Scripts
@@ -139,7 +142,7 @@ yarn dev
139142

140143
### Prepush Hooks
141144

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
143146
implement git hooks. We leverage the prepush hook to do two things:
144147

145148
- Automated code styling (using [`prettier`](https://npm.im/prettier))

packages/firestore/CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,30 @@
22

33
See [Contributing](../../CONTRIBUTING.md) for general information on
44
contributing to the Firebase JavaScript SDK (including Cloud Firestore).
5+
Follow instructions there to install dependencies and set up the testing
6+
environment.
7+
8+
## Setting up an account for testing
9+
10+
You will need a production project to test the Firestore SDK. You can create
11+
a new project by visiting the [Firebase Console](https://console.firebase.google.com/).
12+
Make sure that the project has Cloud Firestore enabled in the database section of the
13+
console.
14+
15+
While setting up tests, you can choose the project manually, or specify the project directly:
16+
17+
```
18+
yarn test:setup --projectId=<your-test-project>
19+
```
520

621
## Running Firestore Tests
22+
723
All commands must be run from this `packages/firestore/` directory.
24+
825
```
26+
# Come up to date on dependencies after performing git pull
27+
(cd ../../; yarn && yarn build)
28+
929
# Run all tests once (browser and node)
1030
yarn test
1131

0 commit comments

Comments
 (0)