aboutsummaryrefslogtreecommitdiffstats
path: root/.storybook
diff options
context:
space:
mode:
authorAlexander Tseung <alextsg@gmail.com>2018-05-08 04:00:16 +0800
committerAlexander Tseung <alextsg@gmail.com>2018-05-08 04:22:29 +0800
commitf70652c83ae1bfbc031e48b754a5ca81cbb3a2d6 (patch)
tree378e1eb662c98da1fe9e0d70a9163ce9877defc3 /.storybook
parentd5759cf4a8041d1a7cfd55a7d55d8b7ecb29caca (diff)
downloadtangerine-wallet-browser-f70652c83ae1bfbc031e48b754a5ca81cbb3a2d6.tar.gz
tangerine-wallet-browser-f70652c83ae1bfbc031e48b754a5ca81cbb3a2d6.tar.zst
tangerine-wallet-browser-f70652c83ae1bfbc031e48b754a5ca81cbb3a2d6.zip
Add storybook README.md file
Diffstat (limited to '.storybook')
-rw-r--r--.storybook/README.md10
1 files changed, 10 insertions, 0 deletions
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.