Skip to content

Commit

Permalink
Merge pull request #14 from Exabyte-io/feature/SOF-6829
Browse files Browse the repository at this point in the history
SOF-6829: Update readme
  • Loading branch information
zoomchik authored Aug 11, 2023
2 parents 2f7755e + 506f8c1 commit b09f449
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,32 @@ For development:

```bash
git clone https://github.com/Exabyte-io/cove.js.git
cd cove.js
npm install
npm run transpile
```

How to link cove.js to host app:
```bash
rm -rf {PATH}/exabyte-stack/web-app/src/application/node_modules/@exabyte-io/cove.js/dist
ln -s "$(pwd)/dist/" /{ABSOLUTE_PATH}/exabyte-stack/web-app/src/application/node_modules/@exabyte-io/cove.js
restart host app (web-app, wave etc.)
```

another approach is to access cove from repo

```bash
push your branch
replace cove.js version with url in package.json
"@exabyte-io/cove.js": "https://github.com/Exabyte-io/cove.js#cc48da9652840eb0f7d8854e02cb690484e6fab1",
```
make sure to install appropriate versions of peerDependencies from cove.js to host app

DO NOT use `npm link` as it leads to having multiple react libs in app.
See links:
https://github.com/facebook/react/issues/13991
https://legacy.reactjs.org/warnings/invalid-hook-call-warning.html#duplicate-react

### Typescript

Typescript and all necessary type dependencies must be present in dependency section of package.json in order
Expand Down

0 comments on commit b09f449

Please sign in to comment.