Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation to reflect emulator is default for integration tests. #562

Merged
merged 3 commits into from
Jun 24, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion firebase-firestore/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,33 @@ the source root.
Make sure you have created a Firestore instance for your project, before
you proceed.

### Run on Local Emulator
By default, integration tests run against the Firestore emulator.

### Setting up the Firestore Emulator

The integration tests require that the Firestore emulator is running on port
8080, which is default when running it via CLI.

* [Install the Firebase CLI](https://firebase.google.com/docs/cli/).
```
npm install -g firebase-tools
```
* [Install the Firestore
emulator](https://firebase.google.com/docs/firestore/security/test-rules-emulator#install_the_emulator).
```
firebase setup:emulators:firestore
```
* Run the emulator
```
firebase serve --only firestore
```
* Select the `Firestore Integration Tests (Firestore Emulator)` run
configuration to run all integration tests.

To run the integration tests against prod, select `FirestoreProdIntegrationTest`
run configuration.

### Run on Local Android Emulator

Then simply run:
```bash
Expand Down