Skip to content

Commit

Permalink
Updated README for npm v6 downgrade and Storybook
Browse files Browse the repository at this point in the history
  • Loading branch information
zthh626 committed Feb 23, 2021
1 parent 2b25c26 commit c99f928
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ This project was bootstrapped with [Create React App](https://github.com/faceboo

In the project directory, you can run:

### `npm install`

**Note:** Downgrade to NPM V6 for this repo to work correctly. Storybook 6.1.18 is having issues with NPM V7.\
Use `npm install -g npm@6` to downgrade to NPM V6\
https://github.com/storybookjs/storybook/issues/12983

### `npm start`

Runs the app in the development mode.\
Expand All @@ -14,6 +20,13 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm run storybook`

Runs the app in [Storybook](https://storybook.js.org) mode. (We are able to run Storybook and React App at the same time)\
When Storybook runs, it looks for all stories in `src/app/**/` with this regex `*.stories.tsx`.

The page will reload if you make edits.

### `npm test`

Launches the test runner in the interactive watch mode.\
Expand Down

0 comments on commit c99f928

Please sign in to comment.