John O'Keefe
2b4eb31495
Add docs/V3_MIGRATION.md — a full write-up of the wailsv3 desktop migration (backend/frontend/build/CI changes, verification, branch map) and the planned follow-ups (toolchain majors + Android sideload). No behavior change. Add a short notice to README.md: Migrating from v2 — v2 and v3 Secret Service collections coexist (AniTrack vs login) so both versions keep working after the first v3 re-login; the orphaned v2 entries are harmless. Details in docs/V3_MIGRATION.md. No cleanup instructions, by request.
46 lines
2.2 KiB
Markdown
46 lines
2.2 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.
|
||
|
||
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.
|
||
|
||
## 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`.
|