xmr-btc-swap/src-gui
2025-06-08 01:55:29 +02:00
..
public feat: cargo project at root 2024-08-08 00:49:04 +02:00
src Reduce final useAppSelector((s) => s.settings.X) to useSettings((s) => s.X) (#390) 2025-06-08 01:55:29 +02:00
.env.development feat(gui): Approve dialog before publishing Bitcoin lock transaction (#291) 2025-04-18 01:51:55 +02:00
.gitignore docs: generally improve docs and add maker page (#242) 2025-01-21 16:05:05 +01:00
eslint.config.js refactor(gui): Update MUI to v7 (#383) 2025-06-06 22:31:33 +02:00
index.html refactor(gui): Update MUI to v7 (#383) 2025-06-06 22:31:33 +02:00
package-lock.json refactor(gui): Update MUI to v7 (#383) 2025-06-06 22:31:33 +02:00
package.json refactor(gui): Update MUI to v7 (#383) 2025-06-06 22:31:33 +02:00
README.md refactor(gui): Update MUI to v7 (#383) 2025-06-06 22:31:33 +02:00
tsconfig.json wip: WithdrawDialog migrated to Tauri IPC 2024-08-09 19:46:58 +02:00
tsconfig.node.json feat: cargo project at root 2024-08-08 00:49:04 +02:00
vite.config.ts feat(gui, tauri): Accept --testnet flag, default to mainnet (#106) 2024-10-10 14:51:56 +02:00
yarn.lock refactor(gui): Update MUI to v7 (#383) 2025-06-06 22:31:33 +02:00

Requirements

  • For compiling the Rust code: cargo and cargo tauri (installation)
  • For running the Typescript code: node and yarn
  • For formatting and bindings: dprint (cargo install dprint@0.50.0) and typeshare (cargo install typeshare-cli)
  • If you are on Windows and you want to use the check-bindings command you'll need to manually install the GNU DiffUtils (installation) and GNU CoreUtils (installtion). Remember to add the installation path (probably C:\Program Files (x86)\GnuWin32\bin) to the PATH in your enviroment variables.

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