From 25e10dbd829478f221c2c6fe02fa467982b68525 Mon Sep 17 00:00:00 2001 From: vcoppe Date: Sun, 15 Nov 2026 13:09:48 +0100 Subject: [PATCH] add tauri info to readme --- README.md | 1 + tauri/README.md | 38 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 tauri/README.md diff --git a/README.md b/README.md index 4a8f5f895..fb961b0df 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/tauri/README.md b/tauri/README.md new file mode 100644 index 000000000..3d53c25f5 --- /dev/null +++ b/tauri/README.md @@ -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 +```