From 1828f093730d0c9e7e7741a1861607a884836145 Mon Sep 17 00:00:00 2001 From: Kunal Mohta Date: Fri, 29 Dec 2023 15:26:31 +0530 Subject: [PATCH 1/2] chore: add steps in README for linking local meerkat --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index af77632d..32c8c5e3 100644 --- a/README.md +++ b/README.md @@ -40,3 +40,19 @@ There is no application to run, for testing your functionality you need to run t Example of running all tests `npx nx run-many --targets tests --all` +## Link local version of meerkat to a project + +Following steps can be used to link a local version of meerkat to a project:- + +1. At root level of the meerkat repo, run + 1. `npm i` + 2. `npx nx run-many --target=build --all --parallel` +2. Create Symlinks + 1. `cd ./dist/meerkat-core && npm link` + 2. `cd ../meerkat-browser && npm link && npm link @devrev/meerkat-core` +3. Remove meerkat-core & meerkat-browser from `package.json` of the project repo into which meerkat is to be linked +4. At root level of the project repo, run + 1. `rm -rf node_modules && npm i` + 2. `npm link --save meerkat-node meerkat-browser` +5. When done using the local version of meerkat, at the root level of project repo, run + 1. `npm unlink @devrev/meerkat-core @devrev/meerkat-browser` From 76e17576fc1b3756ec2425eda119f5e9881204c4 Mon Sep 17 00:00:00 2001 From: Kunal Mohta Date: Fri, 29 Dec 2023 15:29:10 +0530 Subject: [PATCH 2/2] fix typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 32c8c5e3..a21808da 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,6 @@ Following steps can be used to link a local version of meerkat to a project:- 3. Remove meerkat-core & meerkat-browser from `package.json` of the project repo into which meerkat is to be linked 4. At root level of the project repo, run 1. `rm -rf node_modules && npm i` - 2. `npm link --save meerkat-node meerkat-browser` + 2. `npm link --save @devrev/meerkat-node @devrev/meerkat-browser` 5. When done using the local version of meerkat, at the root level of project repo, run 1. `npm unlink @devrev/meerkat-core @devrev/meerkat-browser`