Skip to content

Commit

Permalink
Merge pull request #427 from wzeller/readme-fix
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
clintonium-119 authored Nov 19, 2024
2 parents a493171 + bd0dc97 commit b987cea
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,29 @@ $ npm install

### Running locally with blip

To work on code in this repository within [blip](https://github.com/tidepool-org/blip 'Tidepool on GitHub: blip'), first do the following from your local blip repository (assuming blip/ and viz/ are sister directories):
To work on code in this repository within [blip](https://github.com/tidepool-org/blip 'Tidepool on GitHub: blip'), first run this command in your viz/ directory:

```bash
$ npm link
```

This creates a "symlink" in the global folder {prefix}/lib/node_modules/\<package\>/ that links \<package\> to the viz/ directory.

Then, go to your local blip repository (assuming blip/ and viz/ are sister directories) and run:

```bash
$ npm link ../viz/
```

This creates a symbolic link from the global folder to the node_modules/ of the blip/ directory.

In this repository, start the build in watch mode:

```bash
$ npm start
```

Finally, back in your local blip repository, follow [the instructions for starting blip locally](http://developer.tidepool.io/blip/#running-locally 'Blip README: running locally').
Finally, back in your local blip repository, follow [the instructions for starting blip locally](https://github.com/tidepool-org/blip?tab=readme-ov-file#running-locally).

### Running locally in React Storybook

Expand Down

0 comments on commit b987cea

Please sign in to comment.