aboutsummaryrefslogtreecommitdiffstats
path: root/.storybook/README.md
diff options
context:
space:
mode:
authorThomas <thomas.b.huang@gmail.com>2018-05-09 04:10:26 +0800
committerThomas <thomas.b.huang@gmail.com>2018-05-09 04:10:26 +0800
commit26c6bddebff70287b0fe805d78d2a13b0212805e (patch)
treee455a93a0f1cec3110f82ff2cb1b16ece1be110d /.storybook/README.md
parentd59105299a5d1e192d0abc9ec8d249a22c7bb489 (diff)
parentc3079ff160e0f0d0db8efb1b80692b293a363226 (diff)
downloadtangerine-wallet-browser-26c6bddebff70287b0fe805d78d2a13b0212805e.tar.gz
tangerine-wallet-browser-26c6bddebff70287b0fe805d78d2a13b0212805e.tar.zst
tangerine-wallet-browser-26c6bddebff70287b0fe805d78d2a13b0212805e.zip
Merge branch 'develop' into e2e-tests
Diffstat (limited to '.storybook/README.md')
-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.