Skip to content

Commit a1aba2b

Browse files
committed
Updated README to include linking instructions
1 parent 832bc4e commit a1aba2b

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,20 @@ implementation. The SDK is built via a combination of all of these packages
168168
which are published under the [`firebase`
169169
scope](https://www.npmjs.com/search?q=scope%3Afirebase) on NPM.
170170

171+
### Testing the SDK Locally
172+
173+
Please be sure to build your repo before proceeding any further.
174+
In order to manually test your SDK changes locally, you must use [yarn link](https://classic.yarnpkg.com/en/docs/cli/link):
175+
176+
```shell
177+
$ cd packages/firebase
178+
$ yarn link # initialize the linking to the other folder
179+
$ cd ../<my-test-app-dir> # cd into your personal project directory
180+
$ yarn link firebase # tell yarn to use the locally built firebase SDK instead
181+
```
182+
183+
This will create a symlink and point your `<my-test-app-dir>` to the locally built version of the firebase SDK.
184+
171185
### Helper Scripts
172186

173187
Each package in the `packages` directory exposes a `dev` script. This script

0 commit comments

Comments
 (0)