Skip to content

Commit b12ed4c

Browse files
committed
doc: document new build process in README
1 parent 5f98f96 commit b12ed4c

File tree

1 file changed

+31
-17
lines changed

1 file changed

+31
-17
lines changed

README.md

Lines changed: 31 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,6 @@ Requirements: [Go](https://golang.org/doc/install), [protoc](https://github.com/
66

77
## One-time Setup
88

9-
Create certificate for browser to backend proxy communication
10-
11-
```
12-
openssl genrsa -out https.key 2048
13-
openssl req -new -x509 -key https.key -out https.cert -days 365
14-
```
15-
169
Install client app dependencies
1710

1811
```sh
@@ -23,16 +16,7 @@ yarn
2316

2417
## Development
2518

26-
- Spin up a local regtest env with nautilus and loopd (See [docker-regtest](https://github.com/lightninglabs/dev-resources/tree/master/docker-regtest))
27-
- Create a `.env.local` file in the `app/` directory with the following content. Replace `<macaroon>` with the HEX encoded admin.macaroon of the LND node to connect to
28-
```
29-
REACT_APP_DEV_MACAROON=<macaroon>
30-
REACT_APP_DEV_HOST=http://localhost:3000
31-
```
32-
- Start backend server, updating the ports for the LND and Loop nodes if necessary
33-
```sh
34-
go run . --lndhost=localhost:10011 --loophost=localhost:11010
35-
```
19+
- Compile and start the GrUB (see [Run the GrUB](#run-the-grub))
3620
- Run the client app in a separate terminal
3721
```sh
3822
cd app
@@ -79,3 +63,33 @@ The value for `debug` is a namespace filter which determines which portions of t
7963
Example filters: `main,action` will only log main and action messages. `*,-action` will log everything except action messages.
8064

8165
The value for `debug-level` determines the verbosity of the logs. The value can be one of `debug`, `info`, `warn`, or `error`.
66+
67+
# Run the GrUB
68+
69+
- Compile the GrUB binary:
70+
```sh
71+
make build
72+
```
73+
- Start the GrUB binary. The following is an example for testnet that starts an
74+
lnd node called `zane` on port `10020` (REST: `8100`), change this to your
75+
needs:
76+
```sh
77+
./shushtar-debug \
78+
--httpslisten=8443 \
79+
--lnd.lnddir=/home/$USER/.lnd-dev-zane \
80+
--lnd.alias=zane \
81+
--lnd.noseedbackup \
82+
--lnd.rpclisten=localhost:10020 \
83+
--lnd.listen=0.0.0.0:9750 \
84+
--lnd.restlisten=localhost:8100 \
85+
--lnd.bitcoin.active \
86+
--lnd.bitcoin.testnet \
87+
--lnd.bitcoin.node=bitcoind \
88+
--lnd.bitcoind.rpchost=localhost \
89+
--lnd.bitcoind.rpcuser=lightning \
90+
--lnd.bitcoind.rpcpass=lightning \
91+
--lnd.bitcoind.zmqpubrawblock=localhost:28332 \
92+
--lnd.bitcoind.zmqpubrawtx=localhost:28333 \
93+
--lnd.debuglevel=debug
94+
```
95+
- You can now access the web interface on https://localhost:8443

0 commit comments

Comments
 (0)