docs: initial README
This commit is contained in:
1 parent
3fb77c3530
commit
4c465a5743
1 file changed
+121
@@ -0,0 +1,121 @@
|
||||
# Osteo Report
|
||||
|
||||
> Bilans de séance d'ostéopathie animalière — application web client-side, export PDF auto-portant.
|
||||
|
||||
Application web pour vétérinaire ostéopathe : saisie du compte rendu de séance,
|
||||
annotation de zones anatomiques sur des schémas, export en PDF propre. Le PDF
|
||||
généré embarque le JSON complet du bilan en pièce jointe native — il peut être
|
||||
ré-importé plus tard pour reprendre l'édition.
|
||||
|
||||
100 % côté client. Aucun serveur, aucune base de données, aucune donnée stockée
|
||||
en dehors du PDF que le praticien télécharge.
|
||||
|
||||
---
|
||||
|
||||
## Tech
|
||||
|
||||
- React 19 / TypeScript 5 strict / Vite 6
|
||||
- Tailwind 4 + shadcn/ui (canary) + `motion` (framer-motion)
|
||||
- Zod (validation runtime des PDFs importés)
|
||||
- Zustand 5 (état + autosave localStorage)
|
||||
- pdf-lib (génération PDF + pièces jointes natives)
|
||||
- react-hook-form, react-router 7, react-zoom-pan-pinch
|
||||
- Vitest + @testing-library/react + Playwright
|
||||
- Docker multi-stage → nginx alpine + Traefik (labels commentés)
|
||||
|
||||
---
|
||||
|
||||
## Prérequis
|
||||
|
||||
- Node ≥ 20.18 (`nvm use` lit `.nvmrc`)
|
||||
- npm 10
|
||||
- Docker (déploiement uniquement)
|
||||
- `npx playwright install chromium` (avant les tests e2e, une seule fois)
|
||||
|
||||
---
|
||||
|
||||
## Démarrage
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run dev # http://localhost:5173
|
||||
```
|
||||
|
||||
## Commandes
|
||||
|
||||
```bash
|
||||
npm run dev # dev server (Vite)
|
||||
npm run build # production build (tsc -b && vite build)
|
||||
npm run preview # preview build sur :4173
|
||||
npm run test # vitest run
|
||||
npm run test:watch # vitest watch
|
||||
npm run test:e2e # playwright
|
||||
npm run lint # eslint
|
||||
npm run lint:fix # eslint --fix
|
||||
npm run typecheck # tsc -b --noEmit
|
||||
npm run format # prettier --write .
|
||||
```
|
||||
|
||||
## Docker
|
||||
|
||||
```bash
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
Le `docker-compose.yml` contient des labels Traefik commentés à activer pour la
|
||||
mise en production sur sous-domaine.
|
||||
|
||||
---
|
||||
|
||||
## Espèces couvertes
|
||||
|
||||
Le formulaire de nouveau bilan propose 9 espèces :
|
||||
|
||||
| Espèce | MVP | Anatomie complète | Base pathologies |
|
||||
|---------|-------|-------------------|------------------|
|
||||
| Cheval | ✅ | en cours | seed initial |
|
||||
| Chien | bientôt | — | — |
|
||||
| Chat | bientôt | — | — |
|
||||
| Lapin | bientôt | — | — |
|
||||
| Bovin | bientôt | — | — |
|
||||
| Chèvre | bientôt | — | — |
|
||||
| Âne | bientôt | — | — |
|
||||
| Mouton | bientôt | — | — |
|
||||
| Porc | bientôt | — | — |
|
||||
|
||||
Le code est conçu pour qu'ajouter une espèce = ajouter un dossier
|
||||
`src/species/<id>/`. Voir [docs/ADDING-A-SPECIES.md](docs/ADDING-A-SPECIES.md).
|
||||
|
||||
---
|
||||
|
||||
## Format PDF
|
||||
|
||||
Chaque PDF exporté contient :
|
||||
|
||||
- Header avec coordonnées du praticien, animal, propriétaire, date.
|
||||
- Pour chaque vue où des zones ont été cliquées : un schéma annoté.
|
||||
- Tableau des findings (zone, pathologie, sévérité, commentaire).
|
||||
- Conclusion + recommandations.
|
||||
- Date de prochain rendez-vous (optionnel).
|
||||
- Footer avec date d'export.
|
||||
- **Pièce jointe `report.json`** : le bilan complet, lisible par cette
|
||||
application pour reprendre l'édition.
|
||||
|
||||
À l'import, l'app vérifie la présence de la pièce jointe, valide le JSON via
|
||||
Zod et restitue l'état. Un PDF externe (pas généré par l'app) est rejeté avec
|
||||
un message clair.
|
||||
|
||||
---
|
||||
|
||||
## Documentation
|
||||
|
||||
- [`docs/ARCHITECTURE.md`](docs/ARCHITECTURE.md) — modules, flux, décisions.
|
||||
- [`docs/ADDING-A-SPECIES.md`](docs/ADDING-A-SPECIES.md) — guide d'ajout d'une espèce.
|
||||
- [`docs/ANATOMY-SVG-CONVENTION.md`](docs/ANATOMY-SVG-CONVENTION.md) — règles SVG anatomique.
|
||||
- [`CLAUDE.md`](CLAUDE.md) — instructions pour Claude Code dans ce repo.
|
||||
|
||||
---
|
||||
|
||||
## Licence
|
||||
|
||||
[AGPL-3.0-or-later](LICENSE) © ZenQuality
|
||||
Reference in new issue
Block a user