Skip to content

Commit 520102a

Browse files
committed
add Electron info to readme
1 parent 29b55a3 commit 520102a

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

README.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,23 @@ Currently a very bare bones prototype demonstrating the following functionality:
88
This is one of the initial steps in trying to realise something like what is described [here](https://gist.github.com/AdamISZ/f062c7453c6973a8287897fe506b9d19).
99

1010

11-
Required steps to test this demo:
11+
## Required steps to test this demo:
12+
13+
### Either: Running the electron app.
14+
15+
One of the main reasons for using a Javascript framework like Angular is that either browser or cross platform desktop clients using Electron are possible. Hence the first test [release](https://github.com/Joinmarket-Org/jmcontrolcenter/releases) (0.0.1dev is the tag) offers an Electron desktop app for Windows, Linux and MacOS. Verify the signature, then unzip and run the executable inside it. To actually see the app in action, you'll need to do the [below](#run-jmwalletd).
16+
17+
(Note that to enable testing, certificate verification is disabled inside this test app; obviously this is not safe and will be replaced with a mechanism to import the cert that the user is using for the backend.)
18+
19+
### Or: Run in the browser.
20+
21+
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.0.5. For this second mode of running, in browser, you will need Angular and its dependencies installed, so this is mainly for developers. There are many guides on the Web.
22+
23+
#### (Development server)
24+
25+
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. As above, you will need to do the [below](#jmwalletd) to test the functionality.
26+
27+
## Run jmwalletd
1228

1329
Check out the `rpc-api-1` branch on [Joinmarket-clientserver](https://github.com/Joinmarket-Org/joinmarket-clientserver).
1430
Go into the virtualenv as for any Joinmarket script.
@@ -21,17 +37,14 @@ pytest --btcconf=/some/dir/bitcoin.conf --btcroot=/some/dir/bitcoin-0.19.0.1/bin
2137
Generate a test key and certificate named `key.pem` and `cert.pem` respectively and drop them in the `scripts/` folder of Joinmarket.
2238
Run the new daemon with : `python jmwalletd.py` in that `scripts/` folder and in the Joinmarket `jmvenv` as usual.
2339

24-
Then run the Angular project as described below:
2540

2641
===============
2742

28-
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 10.0.5.
29-
30-
## Development server
43+
## Once frontend and backend are running:
3144

32-
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`.
45+
Only one functionality has been implemented: load and display a wallet.
3346

34-
From here you can click "Unlock wallet", fill in wallet file name and password, and the wallet contents will be displayed automatically.
47+
You can click "Unlock wallet", fill in wallet file name and password, and the wallet contents will be displayed automatically.
3548

3649
You will probably want to first generate a regtest wallet with a filename and then fund it from the test wallets provided by `ygrunner.py` (but an empty wallet will be a start).
3750

0 commit comments

Comments
 (0)