From da0b9c8f260a27a5d39937b17744bffa814b5c2c Mon Sep 17 00:00:00 2001 From: Alex Date: Mon, 22 Feb 2021 21:21:33 -0800 Subject: [PATCH] Updated README with more context about Storybook + issue --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 93a2fafc..756fd89d 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,8 @@ In the project directory, you can run: ### `npm install` -**Note:** Storybook 6.1.18 was having issues with NPM V7, so for this to be run properly -downgrade to NPM V6. +**Note:** Downgrade to NPM V6 for this repo to work correctly. Storybook 6.1.18 is having issues with NPM V7.\ +https://github.com/storybookjs/storybook/issues/12983 ### `npm start` @@ -19,6 +19,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.\