diff --git a/README.md b/README.md index 5ad2b1f2..e8bd4ea0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,19 @@ # Osteo Report -Single-praticien web app for veterinary osteopathy bilans on animal anatomy SVGs — click zones, build observations, export a self-contained PDF with embedded JSON for re-import. +Web app for veterinary osteopaths to write session bilans on animal anatomy +SVGs — click zones, build observations, export a self-contained PDF with the +full report JSON embedded as a native PDF attachment. Re-importing that PDF +restores the state for a follow-up. + +Multi-species by design. MVP data set covers the **horse** (équin). Additional +species — dog, cat, goat, cow, pig, rabbit, donkey, sheep — drop in by adding +their SVG schematic + manifest + pathology file under `src/domain/species/`. +See [`docs/ADDING-A-SPECIES.md`](docs/ADDING-A-SPECIES.md) for the recipe. + +Open to every praticien who wants to use it. No authentication, no backend, +no central server in v1 — the PDF is the long-term record. Phase 2 will add +optional praticien accounts + server-side persistence on the same data +contract. --- @@ -119,11 +132,15 @@ v1.0 MVP — implementation complete. - `pnpm test:run` ✅ — 88 tests across 23 files - `pnpm build` ✅ — 979 kB JS (349 kB gzip), 20 kB CSS -Equine species ships with the real `Horse.svg` + `Horse_head.svg` anatomy -sources at `public/species/equine/`. The pathology reference DB is -intentionally empty in v1; praticien adds entries via the free-text input. -Source-cited DB authoring is deferred to v1.1 once the multi-user -architecture is decided (see `docs/superpowers/specs/2026-05-18-osteo-report-mvp-design.md` +The first species data set ships with the real `Horse.svg` + `Horse_head.svg` +anatomy sources at `public/species/equine/`. Adding **dog, cat, goat, cow, +pig, rabbit, donkey, sheep** is the same procedure: convention-compliant SVG + +manifest + pathology file. See `docs/ADDING-A-SPECIES.md`. + +The pathology reference DB is intentionally empty in v1; the praticien adds +entries via the free-text input. Source-cited DB authoring is deferred to +v1.1 once the multi-praticien account architecture is decided (see +`docs/superpowers/specs/2026-05-18-osteo-report-mvp-design.md` §Prerequisites/REMAINING). Manual QA checklist: `.claude/audits/MVP-QA.md` — walk it through `pnpm dev` diff --git a/docs/superpowers/specs/2026-05-18-osteo-report-mvp-design.md b/docs/superpowers/specs/2026-05-18-osteo-report-mvp-design.md index bad33f22..2bd80bf1 100644 --- a/docs/superpowers/specs/2026-05-18-osteo-report-mvp-design.md +++ b/docs/superpowers/specs/2026-05-18-osteo-report-mvp-design.md @@ -5,20 +5,28 @@ Status: Approved at validation gate #1. ## Purpose -Single-praticien web app for veterinary osteopathy bilans. The praticien -selects an animal species, clicks anatomical zones on an SVG schematic to -build clinical observations (groups of zones sharing one problem), attaches -pathologies (curated DB + free-text) and severity per observation, writes a -conclusion + recommendations + next RDV, and exports the whole report as a -self-contained A4 PDF whose JSON state is carried as a native PDF -attachment. Re-importing the PDF restores the state for a follow-up. +Web app for veterinary osteopaths — any praticien who wants to use it — to +write session bilans on animal anatomy. The praticien selects a species, +clicks anatomical zones on an SVG schematic to build clinical observations +(groups of zones sharing one problem), attaches pathologies (curated DB + +free-text) and severity per observation, writes a conclusion + +recommendations + next RDV, and exports the whole report as a self-contained +A4 PDF whose JSON state is carried as a native PDF attachment. Re-importing +the PDF restores the state for a follow-up. -Static SPA, no backend, no auth, no analytics. Deployed as a Docker image -serving nginx behind a host nginx reverse proxy on Scaleway VPS. Identity -strings (site name, brand, footer) come from env vars, never hardcoded. -Open-source (MIT). +Multi-species by architecture. v1 ships data for the **horse** (équin) only. +Adding **dog, cat, goat, cow, pig, rabbit, donkey, sheep** later is a pure +data drop: convention-compliant SVG + manifest entry + (eventually) +pathology file under `src/domain/species//`. No code changes required. -MVP species: equine only. +Static SPA, no backend, no auth, no analytics in v1 — the PDF is the only +durable artifact. Deployed as a Docker image serving nginx behind a host +nginx reverse proxy on Scaleway VPS. Identity strings (site name, brand, +footer) come from env vars, never hardcoded. Open-source (MIT). + +v1 data set: equine. v1.1+ data sets: chien, chat, chèvre, vache, cochon, +lapin, âne, mouton. Phase 2 also adds multi-praticien accounts + +server-side persistence on the same data contract. ## Stack