Skip to content

Commit bfbbff9

Browse files
authored
Update test setup instructions in README.md (firebase#2654)
1 parent 9c22251 commit bfbbff9

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,12 @@ $ yarn build
8888
A production project is required to test the Firebase JS SDK. You can create a
8989
new project by visiting the [Firebase Console](https://console.firebase.google.com/).
9090

91-
#### Firestore Support
91+
#### Firestore Database Setup
9292

93-
Visit the database section of the console and enable the Cloud Firestore Beta.
94-
You can select either of the default permissions settings as we will overwrite
95-
them below.
93+
Visit the "Database" section of the console and create a Cloud Firestore
94+
database. When prompted to select the set of initial security rules, select
95+
any option (e.g. "Start in Production Mode") since these permission settings
96+
will be overwritten below.
9697

9798
#### Authentication Support
9899

@@ -101,17 +102,25 @@ sign-in provider to complete your project config.
101102

102103
#### Automated Setup
103104

104-
The remainder of the test setup requires choosing a test project. You can
105-
choose the project manually or specify the project directly at the root of
106-
the package.
105+
The tests need to be configured to use the Firebase production project that you
106+
created in the "Test Setup" section above. To do this, run the `yarn test:setup`
107+
command, as follows:
108+
107109

108110
```bash
109-
# Select a project manually when running setup
111+
# Select the Firebase project via the text-based UI.
110112
$ yarn test:setup
111113

112-
# Specify the specific project for setup
113-
$ yarn test:setup --projectId=<your-test-project>
114+
# Specify the Firebase project via the command-line arguments.
115+
$ yarn test:setup --projectId=<test_firebase_project_id>
116+
```
117+
118+
If you see an error like
119+
```
120+
HTTP Error: 404, Project '<test_firebase_project_id>' does not exist.
114121
```
122+
then make sure that you have created the database as specified in the "Firestore
123+
Database Setup" section above.
115124

116125
### Running the tests
117126

0 commit comments

Comments
 (0)