Skip to content

Commit 756db42

Browse files
authored
update to required steps and required tool versions (#7252)
Update the readme to reflect currently required tool versions (node, yarn and jdk) and gsutil auth steps.
1 parent f5aec7b commit 756db42

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

README.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Please see [Environment Support](https://firebase.google.com/support/guides/envi
2929
#### Node.js
3030

3131
Before you can start working on the Firebase JS SDK, you need to have Node.js
32-
installed on your machine. The currently supported versions are `10.15.0` or greater.
32+
installed on your machine. The currently supported versions are `10.15.0` through `16.6.0`.
3333

3434
To download Node.js visit https://nodejs.org/en/download/.
3535

@@ -43,9 +43,14 @@ In addition to Node.js we use `yarn` to facilitate multi package development.
4343
To install `yarn` follow the instructions listed on their website:
4444
https://yarnpkg.com/en/docs/install
4545

46+
This repo currently supports building with yarn `1.x`. For instance, after installating yarn, run
47+
```bash
48+
$ yarn set version 1.22.11`
49+
```
50+
4651
#### Java
4752

48-
The closure compiler requires a modern Java installation. Java 8+ should be installed: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
53+
The closure compiler requires a modern Java installation. Java 11+ should be installed: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html
4954

5055
#### Verify Prerequisites
5156

@@ -57,8 +62,8 @@ $ yarn -v
5762
$ java -version
5863
```
5964

60-
Your Node.js version should be `10.15.0` or greater, your `yarn` version should
61-
be `1.0.0` or greater, and your `java` version should be `1.8.0` or greater.
65+
Your `node` version should be between `10.15.0` and `16.6.0`, your `yarn` version should
66+
be between `1.0.0` and `1.22.11`, and your `java` version should be `11.0` or greater.
6267

6368
_NOTE: We will update the documentation as new versions are required, however
6469
for continuing development on the SDK, staying up to date on the stable versions
@@ -109,7 +114,7 @@ will be overwritten below.
109114
110115
Visit the "Realtime Database" section of the console and create a realtime
111116
database. When prompted to select the set of initial security rules, select
112-
any option (e.g. "Start in Production Mode") since these permission settings
117+
any option (e.g. "Start in Locked Mode") since these permission settings
113118
will be overwritten below.
114119
115120
#### Storage Setup
@@ -127,8 +132,10 @@ order to run the tests, you will need to update your bucket's CORS rules.
127132
}
128133
]
129134
```
130-
2. Install `gsutil` from https://cloud.google.com/storage/docs/gsutil_install
131-
3. Run `gsutil cors set cors.json gs://<your-cloud-storage-bucket>`
135+
1. Install `gsutil` from https://cloud.google.com/storage/docs/gsutil_install
136+
1. You will need to login if this is your first time using `gsutil`. Run `gcloud auth login`
137+
and follow the instructions to login.
138+
1. Run `gsutil cors set cors.json gs://<your-cloud-storage-bucket>`
132139
133140
For more information, visit https://firebase.google.com/docs/storage/web/download-files#cors_configuration
134141

0 commit comments

Comments
 (0)