mirror of
https://github.com/gpxstudio/gpx.studio.git
synced 2026-11-18 07:27:43 +00:00
81 lines
3.7 KiB
Markdown
81 lines
3.7 KiB
Markdown
<picture>
|
||
<source media="(prefers-color-scheme: dark)" srcset="website/static/logo-dark.svg">
|
||
<img alt="Logo of gpx.studio." src="website/static/logo.svg">
|
||
</picture>
|
||
|
||
[**gpx.studio**](https://gpx.studio) is an online tool for creating and editing GPX files.
|
||
|
||

|
||
|
||
This repository contains the source code of the website.
|
||
|
||
## Contributing
|
||
|
||
Please create an issue if you find a bug or have a feature request.
|
||
|
||
Code contributions are also welcome, but except for obvious bug fixes, please open an issue first to discuss the changes you would like to make.
|
||
|
||
## Translation
|
||
|
||
The website is translated by volunteers on a collaborative translation platform.
|
||
You can help complete and improve the translations by joining the [Crowdin project](https://crowdin.com/project/gpxstudio).
|
||
If you would like to start the translation in a new language, please contact me or create an issue.
|
||
|
||
Any help is greatly appreciated!
|
||
|
||
## Development
|
||
|
||
The code is split into four parts:
|
||
|
||
- `gpx-rs`: a Rust library for parsing and manipulating GPX files (the engine), and the interface to it that the next two share (`gpx_engine::api`),
|
||
- `wasm`: the engine for the browser, compiled to WebAssembly,
|
||
- `tauri`: the desktop app, which runs the engine natively,
|
||
- `website`: the website itself, which is a [SvelteKit](https://kit.svelte.dev/) application. It also is the UI of the desktop app.
|
||
|
||
You will need [Node.js](https://nodejs.org/), [Rust](https://rustup.rs/) and [wasm-pack](https://rustwasm.github.io/wasm-pack/) to build and run the website. See [`tauri`](tauri/README.md) for the desktop app.
|
||
|
||
### Building the WebAssembly engine
|
||
|
||
```bash
|
||
cd wasm
|
||
wasm-pack build --target bundler
|
||
```
|
||
|
||
### Running the website
|
||
|
||
To be able to load the map, you will need to create your own <a href="https://cloud.maptiler.com/auth/widget?next=https://cloud.maptiler.com/maps/" target="_blank">MapTiler key</a> and store it in a `.env` file in the `website` directory.
|
||
|
||
```bash
|
||
cd website
|
||
echo PUBLIC_MAPTILER_KEY={YOUR_MAPTILER_KEY} >> .env
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
## Credits
|
||
|
||
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
|
||
- [tailwindcss](https://github.com/tailwindlabs/tailwindcss) — easy styling
|
||
- [Chart.js](https://github.com/chartjs/Chart.js) — beautiful and fast charts
|
||
- Logic:
|
||
- [SortableJS](https://github.com/SortableJS/Sortable) — creating a sortable file tree
|
||
- Mapping:
|
||
- [MapLibre GL JS](https://github.com/maplibre/maplibre-gl-js) — beautiful and fast interactive map rendering
|
||
- [GraphHopper](https://github.com/graphhopper/graphhopper) — powerful routing engine
|
||
- [OpenStreetMap](https://www.openstreetmap.org) — open map data used by most of the map layers, and by the routing engine
|
||
- [Mapterhorn](https://github.com/mapterhorn/mapterhorn) — high-quality open terrain data used by some map layers (including for 3D), and by the routing engine
|
||
- Search:
|
||
- [DocSearch](https://github.com/algolia/docsearch) — search engine for the documentation
|
||
|
||
## License
|
||
|
||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|