John O'Keefe
bc1f4b1482
Runtime box now leads with the tarball install_linux.sh (which installs the webkit runtime for supported distros) and keeps manual per-distro commands as fallback. Add an Updates section: desktop Linux releases self-update in-app (signed, verified), binary-only; icons and .desktop still come from the tarball.
70 lines
3.5 KiB
Markdown
70 lines
3.5 KiB
Markdown
# README
|
||
|
||
## About
|
||
|
||
Track the anime you are watching by syncing with various services. Anilist, MyAnimeList, Simkl...
|
||
|
||
This has been built with the official Wails Svelte-TS template.
|
||
|
||
To run as is, please feel free to download a binary from the releases page.
|
||
|
||
> **To run:** install the WebKitGTK 6 runtime first — it is not preinstalled
|
||
> on most distros, and the app will not start without it
|
||
> (`error while loading shared libraries: libwebkitgtk-6.0.so.4`).
|
||
> The release tarball's `install_linux.sh` installs it automatically
|
||
> (Arch, Debian/Ubuntu, Fedora, Void, OpenMandriva). Manual fallback —
|
||
> Arch: `sudo pacman -S webkitgtk-6.0` ·
|
||
> Debian/Ubuntu: `sudo apt install libwebkitgtk-6.0-4`.
|
||
|
||
If you are getting too many errors due to api usage, please build from source.
|
||
|
||
## Build from Source
|
||
|
||
### Get API Keys
|
||
First you will need your own API keys for the various services the app connects to.
|
||
AniList: [AniList Developer App](https://anilist.co/settings/developer)
|
||
MyAnimeList: [MyAnimeList Developer App](https://myanimelist.net/apiconfig/create)
|
||
Simkl: [Simkl Developer](https://simkl.com/settings/developer/)
|
||
|
||
- Name: AniTrack
|
||
- Redirect URL: http://localhost:6734/callback
|
||
- App Type: web
|
||
- Homepage URL: http://localhost or the Github URL
|
||
- Company Name: AniTrack
|
||
- Commercial/Non-Commercial: non-commercial
|
||
- Purpose of Use: hobbyist
|
||
|
||
Once you have the IDs, Keys, and Secrets create an environment.go file based on the environment.go.example and fill in the fields.
|
||
|
||
### Install Wails and Dependencies
|
||
Please follow the instructions [here](https://v3.wails.io/getting-started/your-first-app/) to get Wails v3 up and running and follow the instructions below.
|
||
|
||
System packages for building (the WebKitGTK 6 runtime above, plus
|
||
compilers and headers) — Arch: `sudo pacman -S base-devel gtk4 webkitgtk-6.0 go nodejs npm` ·
|
||
Debian/Ubuntu: `sudo apt install build-essential pkg-config libgtk-4-dev libwebkitgtk-6.0-dev golang nodejs npm`,
|
||
then install the pinned CLI with `go install github.com/wailsapp/wails/v3/cmd/wails3@v3.0.0-beta.20`.
|
||
|
||
> **Versioning note:** `1.99.x` is the v3-migration beta series — Wails v3
|
||
> underneath, Svelte 4/Vite 4 toolchain refresh still pending. `2.0.0` is
|
||
> reserved for the finished article. See `docs/V3_MIGRATION.md`.
|
||
|
||
## Live Development
|
||
|
||
To run in live development mode, run `make dev` in the project directory (it runs `wails3 dev`). This starts a Vite development
|
||
server on http://localhost:5173 with very fast hot reload of your frontend changes, alongside the desktop app window.
|
||
|
||
## Migrating from v2
|
||
|
||
The `wailsv3` branch moves AniTrack from Wails `v2` → `v3` and from `99designs/keyring` → `zalando/go-keyring`. Both versions can coexist: on Linux, `v2` tokens live in an `AniTrack` Secret Service collection while `v3` uses the `login` collection, so one does not overwrite the other. After you log into AniList / MAL / Simkl once on `v3`, the `v2` entries become stale but harmless orphans — leave them if you still run both versions, or clear the old collection when you’ve fully moved over. See `docs/V3_MIGRATION.md` for the full migration summary and next steps (including planned Android support).
|
||
|
||
## Building
|
||
|
||
To build a redistributable, production mode package, use `make build`. The binary lands at `build/bin/AniTrack`.
|
||
|
||
## Updates
|
||
|
||
Desktop Linux releases self-update: the app checks for a newer release at
|
||
startup and offers it in-app (signed, verified before install). Only the
|
||
binary updates itself — icons and the `.desktop` file still come from the
|
||
release tarball. Details in `docs/V3_MIGRATION.md: Self-updates`.
|