Skip to content

Commit f272008

Browse files
committed
Merge branch 'simulatorAppDocs'
2 parents 12e6e60 + d522a03 commit f272008

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,25 @@ Run `make servewallet` and `make webdev` in seperate terminals.
8484
Before the first use of `make webdev`, you also need to run `make buildweb`, to install the dev
8585
dependencies.
8686

87+
#### Local development with BB02 simulator
88+
89+
The app can be used together with a [BB02 simulator](https://github.com/BitBoxSwiss/bitbox02-firmware/tree/master/test/simulator).
90+
91+
In order to do so:
92+
93+
* Build the simulator (checkout https://github.com/BitBoxSwiss/bitbox02-firmware/, then from the root repo run `make dockerdev` followed by `make simulator`)
94+
95+
* Execute the simulator.
96+
97+
* Use `--port` if you want it to listen to a custom port (default is 15423)
98+
99+
* Set the environment variable `FAKE_MEMORY_FILEPATH` to a filepath if you want the simulator to write to file rather than in memory. This allows to re-use the same seed across different executions.
100+
101+
* Launch the BBApp in simulator mode by providing a custom flag `--simulator`.
102+
103+
104+
If the simulator is listening on a custom port, `--simulatorPort=<port>` must also be provided.
105+
87106
#### Watch and build the UI
88107

89108
Run `make webdev` to develop the UI inside a web browser (for quick development, automatic rebuilds

0 commit comments

Comments
 (0)