From f70652c83ae1bfbc031e48b754a5ca81cbb3a2d6 Mon Sep 17 00:00:00 2001 From: Alexander Tseung Date: Mon, 7 May 2018 13:00:16 -0700 Subject: [PATCH] Add storybook README.md file --- .storybook/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 .storybook/README.md diff --git a/.storybook/README.md b/.storybook/README.md new file mode 100644 index 000000000..03b06d854 --- /dev/null +++ b/.storybook/README.md @@ -0,0 +1,10 @@ +# Storybook +We're currently using [Storybook](https://storybook.js.org/) as part of our design system. To run Storybook and test some of our UI components, clone the repo and run the following: +``` +npm install +npm run storybook +``` +You should then see: +> info Storybook started on => http://localhost:6006/ + +In your browser, navigate to http://localhost:6006/ to see the Storybook application. From here, you'll be able to easily view components and even modify some of their properties.