Skip to content

chore: add steps in README for linking local meerkat #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 29, 2023
Merged

chore: add steps in README for linking local meerkat #45

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1828f09
chore: add steps in README for linking local meerkat
kunal-mohta-99 Dec 29, 2023
76e1757
fix typo
kunal-mohta-99 Dec 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 @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`