aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorSebastian <sebasjm@gmail.com>2021-07-13 11:48:24 -0300
committerSebastian <sebasjm@gmail.com>2021-07-13 11:48:34 -0300
commita2ff528c66255e8872fc85aadca471335c46ac2b (patch)
tree7968039ec3056368864f80ca93dcc4589a14db02 /README
parent72f7664c709ce2e2bb383ec4559cdf2703d7592a (diff)
added information about how to run storybook
Diffstat (limited to 'README')
-rw-r--r--README23
1 files changed, 20 insertions, 3 deletions
diff --git a/README b/README
index cea727910..2f543f449 100644
--- a/README
+++ b/README
@@ -24,6 +24,11 @@ The CLI version of the wallet supports the normal GNU installation process.
./configure [ --prefix=$PREFIX ] && make install
```
+### Compiling from Git
+
+If you are compiling the code from git, you have to run `./bootstrap` before
+running `./configure`.
+
### Building the WebExtension
The WebExtension can be built via the 'webextension' make target:
@@ -86,12 +91,24 @@ Then, you can proceed with these instructions:
(host)$ docker cp walletcontainer:/wallet-core-$version/packages/taler-wallet-webextension/extension extension
```
+### Reviewing WebExtension UI examples
-### Compiling from Git
+The WebExtension can be tested using Storybook. Using live server or building
+static html files to deploy into nginx.
-If you are compiling the code from git, you have to run `./bootstrap` before
-running `./configure`.
+To run a live server use the 'dev-view' target
+
+```shell
+make dev-view
+```
+
+A server will start, usually at http://localhost:6006/.
+On the left it will have a navigation panel with examples organized in a tree view.
+
+Stories are defined with a *.stories.tsx file [1], you are free to create new or edit
+some and commit them in order to create a more complete set of examples.
+[1] look for them at packages/taler-wallet-webextension/src/**/*.stories.tsx
# Integration Tests