add tauri info to readme

This commit is contained in:
vcoppe committed 2026-11-15 13:09:48 +01:00
1 parent af46423859
commit 25e10dbd82
2 files changed
+39

No files matched your search

+1
View File
@@ -59,6 +59,7 @@ This project has been made possible thanks to the following open source projects
- Development:
- [Svelte](https://github.com/sveltejs/svelte) and [SvelteKit](https://github.com/sveltejs/kit) — seamless development experience
- [MDsveX](https://github.com/pngwn/MDsveX) — allowing a Markdown-based documentation
- [Tauri](https://github.com/tauri-apps/tauri) – making a desktop app possible
- Design:
- [shadcn-svelte](https://github.com/huntabyte/shadcn-svelte) — beautiful components
- [@lucide/svelte](https://github.com/lucide-icons/lucide/tree/main/packages/svelte) — beautiful icons
+38
View File
@@ -0,0 +1,38 @@
# tauri
The desktop app of gpx.studio, built with [Tauri 2](https://v2.tauri.app/).
Its UI is the website ([`../website`](../website)), and it runs the engine of [`../gpx-rs`](../gpx-rs) natively instead of in WebAssembly.
## Development
You will need the same tools as for the website: [Node.js](https://nodejs.org/), [Rust](https://rustup.rs/) and [wasm-pack](https://rustwasm.github.io/wasm-pack/).
To run the app in development mode, you will also need to install the [system dependencies of Tauri](https://v2.tauri.app/start/prerequisites/) for your platform and the Tauri CLI:
```bash
cargo install tauri-cli --version "^2"
```
### Setting up the frontend
The desktop app does not use the WebAssembly engine, but the website depends on its package.
From the root of the repository, build it once and install the website’s dependencies:
```bash
cd wasm && wasm-pack build --target bundler && cd ..
npm install --prefix website
```
For the MapTiler layers, add your key to `website/.env`, as explained in the [main README](../README.md#running-the-website).
### Running the app
```bash
cd tauri
cargo tauri dev
```
### Testing
```bash
cargo test -p gpx-studio-desktop
```