John O'Keefe
2ab0843a0c
Fixes the wails3 dev boot failure and removes remaining v2-isms so the tree matches a stock v3 project. - frontend/package.json: add missing build:dev script (vite build --minify false --mode development). The dev taskflow runs npm run build:dev, which v2-era package.json never had - this was the wails3 dev boot failure. - frontend/vite.config.ts: add the @wailsio/runtime vite plugin (typed custom events, as in every v3 template) and the server host/port/strictPort block (5173, matching the dev task). - Remove stale v2 build dirs build/darwin + build/windows (v2 wails scaffolding; v3 generates its own via build-assets if ever needed). - Delete untracked frontend/package.json.md5 (v2 change-detection artifact; v3 Taskfile uses content-hash sources) and drop its gitignore rule. - go.mod: delete the leftover commented-out v2 replace directive. - README.md: dev/build docs updated to make dev / make build (wails3), dropping the v2 :34115 browser-server paragraph; install link points at v3 docs. Verified: production vite build green with the plugin, and wails3 dev boots end-to-end (bindings regen, build:dev, vite on :5173, asset server connected, AniTrack 1.6.8 window mapped).
42 lines
1.6 KiB
Markdown
42 lines
1.6 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.
|
|
|
|
## Building
|
|
|
|
To build a redistributable, production mode package, use `make build`. The binary lands at `build/bin/AniTrack`.
|