Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Updating the missing step for linking dependent repo's locally
  • Loading branch information
Kesari3008 committed Apr 16, 2024
1 parent 445764a commit 784f286
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,10 +166,12 @@ Below you can find sample steps for linking a local `components` package to the
```bash
git clone [email protected]:webex/components.git
```

2. Build `components` code. This will generate a `dist` folder
```bash
cd components
npm install
npx npm-install-peers (This is required to install peer dependencies if npm version is lower than 7)
npm run build
```
Expand All @@ -178,11 +180,13 @@ Below you can find sample steps for linking a local `components` package to the
"@webex/components": "file:../components", // Or corresponding path to local clone
npm install
```
4. Install dependencies of `widgets` repository and the react dependency (this is required because`components` repository uses react)
4. Install peer dependencies of `widgets` repository and the react dependency (this is required because`components` repository uses react)
```
npx npm-install-peers
npm link ../components/node_modules/react
```
5. Start up the widget sample
```
npm run start
Expand Down

0 comments on commit 784f286

Please sign in to comment.