improve readme
This commit is contained in:
parent
0d81c22708
commit
1e6b2dd150
54
README
54
README
@ -3,18 +3,16 @@
|
||||
This repository contains the implementation of a wallet for GNU Taler written
|
||||
in TypeScript.
|
||||
|
||||
|
||||
## Dependencies
|
||||
|
||||
The following dependencies are required to build the wallet:
|
||||
|
||||
* python>=3.8
|
||||
* nodejs>=12
|
||||
* jq
|
||||
* npm
|
||||
* pnpm
|
||||
* zip
|
||||
|
||||
- python>=3.8
|
||||
- nodejs>=12
|
||||
- jq
|
||||
- npm
|
||||
- pnpm
|
||||
- zip
|
||||
|
||||
## Installation
|
||||
|
||||
@ -93,22 +91,46 @@ Then, you can proceed with these instructions:
|
||||
|
||||
### Reviewing WebExtension UI examples
|
||||
|
||||
The WebExtension can be tested using Storybook. Using live server or building
|
||||
static html files to deploy into nginx.
|
||||
|
||||
The WebExtension can be tested using example stories.
|
||||
To run a live server use the 'dev-view' target
|
||||
|
||||
```shell
|
||||
make webextension-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
|
||||
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
|
||||
[1] look for them at packages/taler-wallet-webextension/src/\*_/_.stories.tsx
|
||||
|
||||
### WebExtension UI Components
|
||||
|
||||
Every group of component have a directory and a README.
|
||||
Testing component is based in two main category:
|
||||
|
||||
- UI testing
|
||||
- State transition testing
|
||||
|
||||
For UI testing, every story example will be taken as a unit test.
|
||||
For State testing, every stateful component should have an `useStateComponent` function that will be tested in a \*.test.ts file.
|
||||
|
||||
### Testing WebExtension
|
||||
|
||||
After building the WebExtension look for the folder `extension`
|
||||
Inside you will find v2 and v3 version referring to the manifest version being used.
|
||||
|
||||
Firefox users:
|
||||
|
||||
- Go to about:addons
|
||||
- Then `debug addon` (or about:debugging#/runtime/this-firefox)
|
||||
- Then `Load temporary addon...`
|
||||
- Select the `taler-wallet-webextension-*.zip`
|
||||
|
||||
Chrome users:
|
||||
|
||||
- Settings -> More tools -> Extensions (or go to chrome://extensions/)
|
||||
- `Load unpacked` button in the upper left
|
||||
- Selected the `unpacked` folder in v2 or v3
|
||||
|
||||
# Integration Tests
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user