Files
hemx/examples/workout/README.md
T
slhx agent f2b6aa1aef feat(workout): add mobile release kit command
Add one canonical Workout mobile release command that builds the production server and writes Android/iOS shell metadata, explicit production policy, and honest external signing/toolchain blockers.

req: examples/001

req: examples/006

req: host/002

req: local/001
2026-06-12 11:02:31 +02:00

89 lines
3.2 KiB
Markdown

# Now-first Workout Copilot example
This is the phone-first local-first product exemplar for hemx. It shows a
complete useful session: next action shown, set completed, rest/next state
entered, progress updated, a mistyped set corrected and undone, workout finished,
final export shared or replayed, and invalid input, replay failure, or host denial
recovered without storing DOM patches or UI update payloads as truth.
req: examples/001 req: local/001 req: local/003 req: local/004
## Run
```sh
cargo run --bin hemx-workout-example
```
Open `http://127.0.0.1:3028`.
If the port is busy, pick another address:
```sh
HEMX_WORKOUT_ADDR=127.0.0.1:3030 cargo run --bin hemx-workout-example
```
The server prints the URL it bound. A bind failure means another process owns
the address; retry with `HEMX_WORKOUT_ADDR` instead of changing app code.
## Test
```sh
cargo test -p hemx-workout-example
```
The E2E test starts the real HTTP binary, loads the page, checks the shared
runtime asset, submits workout interactions, decodes hemx effect responses, and
replays exported events back into a projection. Unit tests cover rest/next,
finish, undo recovery, invalid input, replay failure, export replay, and
host-result boundaries. req: test/001 req: examples/001
For the full repository gate:
```sh
cargo run -p hemx-xtask -- test
```
## Deploy shape
The deployable artifact is the Rust server binary plus the generated hemx
resources embedded by the build script:
```sh
cargo build --release --bin hemx-workout-example
HEMX_WORKOUT_ADDR=0.0.0.0:8080 ./target/release/hemx-workout-example
```
Put a normal reverse proxy or platform router in front of that port. The app
serves the shared hemx runtime through `hemx-axum`; there is no frontend build,
Node runtime, Expo/Ionic/Tauri shell, or handwritten selector UI JavaScript to
ship. req: axum_integration/005 req: examples/005
## Mobile release kit
Use the canonical release command to build the production server binary and
write Android/iOS shell metadata:
```sh
HEMX_WORKOUT_ORIGIN=https://workout.example.com \
cargo run -p hemx-xtask -- workout-mobile release
```
The kit lands in `target/hemx-mobile/workout` unless
`HEMX_WORKOUT_MOBILE_OUT` is set. It records app identity, version, production
origin, runtime asset policy, cache/offline state policy, secrets/signing
boundaries, rollback expectations, Android TWA metadata, iOS WebView metadata,
and any external blocker such as missing Android SDK, Xcode, or store signing
credentials. See `docs/recipes/mobile-release.md`. req: examples/006
## Boundaries proven
- Core workout logging works without network availability once the page/runtime
is loaded: commands/events/projections are app truth, including rest/next,
finish, invalid input, replay failure, and undo recovery. req: local/001
- Browser/PWA export uses the host capability contract and the host result
returns through app code before UI effects. req: host/001 req: host/005
- Native-shell-shaped haptic acknowledgment uses the same host call/event path
without giving the shell ownership of workout state. req: host/002
- Sync, backup, auth, AI/STT, provider policy, and conflict handling are not
hidden in hemx core or the example runtime; they remain explicit app or
integration decisions. req: local/002 req: local/003