From 7740f2f615ae104a19b31a9ca0b392c8e50959c9 Mon Sep 17 00:00:00 2001 From: Venkatesh Devale <61809205+devalevenkatesh@users.noreply.github.com> Date: Thu, 29 Jun 2023 14:56:35 -0700 Subject: [PATCH] Update README to mention build first and then start the storybook (#902) --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 459c0e6d6..79b32c8ec 100644 --- a/README.md +++ b/README.md @@ -62,12 +62,6 @@ git clone https://github.com/aws/amazon-chime-sdk-component-library-react.git npm install ``` -### To run the Storybook server locally - -``` -npm start -``` - ### Build ``` @@ -76,6 +70,14 @@ npm run build Once you build, check and resolve any warnings you may get like unresolved dependencies or circular dependencies. Remove these as it will help in bundling the library warning/error free. +### To run the Storybook server locally + +`amazon-chime-sdk-component-library-react` uses [Storybook](https://storybook.js.org/) for documentation. + +``` +npm start +``` + ### Test Run all unit test suites.