-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA256 4A1tNBcsxhQA7NkswREXTD1QGz8mRyA7fGnCzPyTwqzKdDFMNje7iHUbGhCetfVUZa1PTuZCoPKj8gnJuRrFYJ2R2CEzqbJ is our donation address (signed by binarybaron) -----BEGIN PGP SIGNATURE----- iQGzBAEBCAAdFiEEBRhGD+vsHaFKFVp7RK5vCxZqrVoFAmjxV4YACgkQRK5vCxZq rVrFogv9F650Um1TsPlqQ+7kdobCwa7yH5uXOp1p22YaiwWGHKRU5rUSb6Ac+zI0 3Io39VEoZufQqXqEqaiH7Q/08ABQR5r0TTPtSLNjOSEQ+ecClwv7MeF5CIXZYDdB AlEOnlL0CPfA24GQMhfp9lvjNiTBA2NikLARWJrc1JsLrFMK5rHesv7VHJEtm/gu We5eAuNOM2k3nAABTWzLiMJkH+G1amJmfkCKkBCk04inA6kZ5COUikMupyQDtsE4 hrr/KrskMuXzGY+rjP6NhWqr/twKj819TrOxlYD4vK68cZP+jx9m+vSBE6mxgMbN tBVdo9xFVCVymOYQCV8BRY8ScqP+YPNV5d6BMyDH9tvHJrGqZTNQiFhVX03Tw6mg hccEqYP1J/TaAlFg/P4HtqsxPBZD6x3IdSxXhrJ0IjrqLpVtKyQlTZGsJuNjFWG8 LKixaxxR7iWsyRZVCnEqCgDN8hzKZIE3Ph+kLTa4z4mTNEYyWUNeKRrFrSxKvEOK KM0Pp53f =O/zf -----END PGP SIGNATURE----- |
||
|---|---|---|
| .. | ||
| public | ||
| src | ||
| .env.development | ||
| .gitignore | ||
| eslint.config.js | ||
| index.html | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| tsconfig.node.json | ||
| vite.config.ts | ||
| yarn.lock | ||
Recommended IDE Setup
Requirements
-
For compiling the Rust code:
cargoandcargo tauri(installation) -
For running the Typescript code:
nodeandyarn -
For formatting and bindings:
dprint(cargo install dprint@0.50.0) andtypeshare(cargo install typeshare-cli) -
If you are on Windows and you want to use the
check-bindingscommand you'll need to manually install the GNU DiffUtils (installation) and GNU CoreUtils (installtion). Remember to add the installation path (probablyC:\Program Files (x86)\GnuWin32\bin) to thePATHin your enviroment variables. -
Compiling for Windows is only possible from Ubuntu (x86_64). It requires a very recent mingw version which you'll need to build from source. You can do this by running
just prepare-windows-buildfrom the root of the repository.
Start development servers
For development, we need to run both vite and tauri servers:
cd src-gui
yarn install && yarn run dev
# let this run
cd src-tauri
cargo tauri dev --no-watch -- -- --testnet
# let this run as well
Generate bindings for Tauri API
Running yarn run dev or yarn build should automatically re-build the Typescript bindings whenever something changes. You can also manually trigger this using the gen-bindings command:
yarn run gen-bindings
You can also check whether the current bindings are up to date:
yarn run check-bindings
Debugging
Because the GUI is running in an embedded browser, we can't use the usual Browser extensions to debug the GUI. Instead we use standalone React DevTools / Redux DevTools.
React DevTools
Run this command to start the React DevTools server. The frontend will connect to this server automatically:
npx react-devtools
Redux DevTools
Run this command to start the Redux DevTools server. The frontend will connect to this server automatically. You can then debug the global Redux state. Observe how it changes over time, go back in time, see dispatch history, etc.
You may have to go to Settings -> 'use local custom server' -> connect inside the devtools window for the state to be reflected correctly.
npx redux-devtools --hostname=localhost --port=8098 --open