aboutsummaryrefslogtreecommitdiffstats
path: root/.storybook/README.md
diff options
context:
space:
mode:
authorBruno <brunobar79@gmail.com>2018-05-17 10:38:51 +0800
committerBruno <brunobar79@gmail.com>2018-05-17 10:38:51 +0800
commit3dd58463caef98c2cc1f068931624795a43912db (patch)
treeb49a2e4feffd33e3b96d43ec29f2ca1071912e67 /.storybook/README.md
parent3180b69b974f8ffc0d6546a647725d1bf8539483 (diff)
parent708422432c634ffbd4c73388f980c43f766b3355 (diff)
downloadtangerine-wallet-browser-3dd58463caef98c2cc1f068931624795a43912db.tar.gz
tangerine-wallet-browser-3dd58463caef98c2cc1f068931624795a43912db.tar.zst
tangerine-wallet-browser-3dd58463caef98c2cc1f068931624795a43912db.zip
Merge remote-tracking branch 'upstream/develop' into develop
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.