Skip to content

Commit 09dfc3a

Browse files
authored
Updated local linkage instructions (#6817)
1 parent 243e47d commit 09dfc3a

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -190,14 +190,16 @@ scope](https://www.npmjs.com/search?q=scope%3Afirebase) on NPM.
190190

191191
### Testing the SDK Locally
192192

193-
Please be sure to build your repo before proceeding any further.
193+
Please be sure your product's package has been built before proceeding any further. (If you haven't built this repo before, make sure to run `yarn build` at the root)
194194
In order to manually test your SDK changes locally, you must use [yarn link](https://classic.yarnpkg.com/en/docs/cli/link):
195195

196196
```shell
197197
$ cd packages/firebase
198198
$ yarn link # initialize the linking to the other folder
199-
$ cd ../<my-test-app-dir> # cd into your personal project directory
200-
$ yarn link firebase # tell yarn to use the locally built firebase SDK instead
199+
$ cd ../packages/<my-product> # Example: $ cd packages/database
200+
$ yarn link # link your product to make it available elsewhere
201+
$ cd <my-test-app-dir> # cd into your personal project directory
202+
$ yarn link firebase @firebase/<my-product> # tell yarn to use the locally built firebase SDK instead
201203
```
202204

203205
This will create a symlink and point your `<my-test-app-dir>` to the locally built version of the firebase SDK.

0 commit comments

Comments
 (0)