From 08a9a926e79b6d4e06bbaa6eadedf9179b5cb3d9 Mon Sep 17 00:00:00 2001 From: Maneesh Tewani Date: Mon, 21 Nov 2022 09:53:50 -0800 Subject: [PATCH 1/4] Updated local linkage instructions --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 04953f697bb..9f32b3f83f2 100644 --- a/README.md +++ b/README.md @@ -190,14 +190,16 @@ scope](https://www.npmjs.com/search?q=scope%3Afirebase) on NPM. ### Testing the SDK Locally -Please be sure to build your repo before proceeding any further. +Please be sure to build your SDK changes and install your dependencies before proceeding any further. In order to manually test your SDK changes locally, you must use [yarn link](https://classic.yarnpkg.com/en/docs/cli/link): ```shell $ cd packages/firebase $ yarn link # initialize the linking to the other folder -$ cd ../ # cd into your personal project directory -$ yarn link firebase # tell yarn to use the locally built firebase SDK instead +$ cd packages/ # Example: $ cd packages/database +$ yarn link # link your product to make it available elsewhere +$ cd # cd into your personal project directory +$ yarn link firebase firebase/ # tell yarn to use the locally built firebase SDK instead ``` This will create a symlink and point your `` to the locally built version of the firebase SDK. From 22fcbe870fdde6f4960aa2d685c39aa17b18caae Mon Sep 17 00:00:00 2001 From: Maneesh Tewani Date: Mon, 21 Nov 2022 10:01:37 -0800 Subject: [PATCH 2/4] Updated wording --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 9f32b3f83f2..dd4052cae01 100644 --- a/README.md +++ b/README.md @@ -190,7 +190,7 @@ scope](https://www.npmjs.com/search?q=scope%3Afirebase) on NPM. ### Testing the SDK Locally -Please be sure to build your SDK changes and install your dependencies before proceeding any further. +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) In order to manually test your SDK changes locally, you must use [yarn link](https://classic.yarnpkg.com/en/docs/cli/link): ```shell From 8fd81b72ae44b1d046d76770fd19552a2fbf99c8 Mon Sep 17 00:00:00 2001 From: Maneesh Tewani Date: Mon, 21 Nov 2022 10:03:40 -0800 Subject: [PATCH 3/4] Updated path --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dd4052cae01..933624f52bf 100644 --- a/README.md +++ b/README.md @@ -196,7 +196,7 @@ In order to manually test your SDK changes locally, you must use [yarn link](htt ```shell $ cd packages/firebase $ yarn link # initialize the linking to the other folder -$ cd packages/ # Example: $ cd packages/database +$ cd ../packages/ # Example: $ cd packages/database $ yarn link # link your product to make it available elsewhere $ cd # cd into your personal project directory $ yarn link firebase firebase/ # tell yarn to use the locally built firebase SDK instead From 5d7ac6911e52c51af32381a93ea2b8da6fad15fa Mon Sep 17 00:00:00 2001 From: Maneesh Tewani Date: Tue, 29 Nov 2022 11:40:37 -0800 Subject: [PATCH 4/4] Updated typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 933624f52bf..803d4c40b41 100644 --- a/README.md +++ b/README.md @@ -199,7 +199,7 @@ $ yarn link # initialize the linking to the other folder $ cd ../packages/ # Example: $ cd packages/database $ yarn link # link your product to make it available elsewhere $ cd # cd into your personal project directory -$ yarn link firebase firebase/ # tell yarn to use the locally built firebase SDK instead +$ yarn link firebase @firebase/ # tell yarn to use the locally built firebase SDK instead ``` This will create a symlink and point your `` to the locally built version of the firebase SDK.