Skip to content

Commit e7a1a33

Browse files
chore: add steps in README for linking local meerkat (#45)
* chore: add steps in README for linking local meerkat * fix typo
1 parent cc2638e commit e7a1a33

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,19 @@ There is no application to run, for testing your functionality you need to run t
4040
Example of running all tests
4141
`npx nx run-many --targets tests --all`
4242

43+
## Link local version of meerkat to a project
44+
45+
Following steps can be used to link a local version of meerkat to a project:-
46+
47+
1. At root level of the meerkat repo, run
48+
1. `npm i`
49+
2. `npx nx run-many --target=build --all --parallel`
50+
2. Create Symlinks
51+
1. `cd ./dist/meerkat-core && npm link`
52+
2. `cd ../meerkat-browser && npm link && npm link @devrev/meerkat-core`
53+
3. Remove meerkat-core & meerkat-browser from `package.json` of the project repo into which meerkat is to be linked
54+
4. At root level of the project repo, run
55+
1. `rm -rf node_modules && npm i`
56+
2. `npm link --save @devrev/meerkat-node @devrev/meerkat-browser`
57+
5. When done using the local version of meerkat, at the root level of project repo, run
58+
1. `npm unlink @devrev/meerkat-core @devrev/meerkat-browser`

0 commit comments

Comments
 (0)