Keysat
284c5ff079
- New Settings editor: rename categories (emoji/color too), rename metrics, change unit and type, add/remove metrics, set step + record tracking, archive/unarchive, and permanently delete categories. - Settings now lists archived categories so they can be restored/deleted. - Backend: add DELETE /api/categories/:id (cascades metrics, entries, entry_values, plans, goals). - Bump StartOS package to 0.1.6:0; service worker cache to v6.
41 lines
3.3 KiB
Markdown
41 lines
3.3 KiB
Markdown
# Premier Gunner
|
||
|
||
Premier Gunner is a kid-friendly, mobile-friendly soccer training tracker built for one player. Log daily training across categories (juggling, shooting, dribbling, soccer tennis, and more), plan upcoming sessions, set goals, and watch progress climb the thermometer toward the big reward.
|
||
|
||
## Getting set up
|
||
|
||
1. Open Premier Gunner's **Dashboard** tab and click the **Premier Gunner** web interface to open the app.
|
||
2. You'll land on a **login screen** asking for a password. A strong random password is generated automatically when the service is installed.
|
||
3. To set your own password, run the **Set Login Password** action (Actions tab). Enter the password Gunner will type on the login screen (at least 4 characters) and save. The service restarts and the new password takes effect immediately. Any active logins are signed out.
|
||
|
||
> The login password is managed entirely by the **Set Login Password** action. Changing it inside the app's own Settings screen will be overwritten on the next restart, so always use the action.
|
||
|
||
## What you get on StartOS
|
||
|
||
- **A single-user web app**, password protected, reachable over your StartOS networking (Tor, LAN, or a clearnet domain via StartTunnel).
|
||
- **Daily logging** by category with point-and-click steppers, plus optional per-session notes.
|
||
- **Full category management** in Settings — rename categories, change their emoji/color, add or remove the metrics each one tracks, rename metrics, and change their unit and type (count, time, 0–10 score, or decimal). Categories can be archived (hidden, data kept) or deleted permanently.
|
||
- **Personal-best records** — turn on 🏆 tracking for any metric (juggling is on by default). Set the current record by hand in Settings, and it updates automatically whenever a session beats it.
|
||
- **1-on-1 with Elijah scores** — log a Technical Skill score and an Effort score (out of 10) alongside the session note.
|
||
- **Planning, goals, and a dashboard** with a streak calendar, training-spread radar, improvement charts, a records list, and the main-goal thermometer.
|
||
- **Persistent data** stored in the package's `main` volume (`/data`), included in StartOS backups.
|
||
- **One action** — Set Login Password.
|
||
|
||
### Updates
|
||
|
||
When you install a new version of Premier Gunner, the installed web app (including a phone home-screen PWA) detects it automatically and shows a **"A new version is ready! — Refresh"** banner. Tap **Refresh** to update instantly. If you don't, it updates on its own the next time you fully close and reopen the app.
|
||
|
||
## Exposing on a clearnet domain (StartTunnel)
|
||
|
||
Premier Gunner serves plain HTTP on its interface; StartOS terminates TLS. To reach it from a normal browser on the open internet:
|
||
|
||
1. Install and configure **StartTunnel** and point a domain at this service's **ui** interface (see the [StartTunnel docs](https://docs.start9.com/start-tunnel/1.0.x/)).
|
||
2. Add the clearnet address to the **ui** interface so the app's session cookie is issued for that host.
|
||
|
||
The app sets its session cookie with the `Secure` flag in production, so it requires HTTPS — which StartTunnel provides.
|
||
|
||
## Limitations
|
||
|
||
- Premier Gunner is intentionally single-user. There are no separate accounts; everyone who has the password shares the same data.
|
||
- The login password must be changed via the **Set Login Password** action, not the in-app Settings screen, when running on StartOS.
|