Files
home_hub/docs/plan.md
T
2026-05-25 06:50:09 +02:00

9.7 KiB
Raw Blame History

HomeHub — Plan de développement

Approche itérative : chaque phase livre quelque chose d'utilisable.
Stack : FastAPI · React/Vite/TS · PostgreSQL 16 · Docker Compose


Phase 1 — Socle technique

Objectif : environnement opérationnel, rien de métier, mais tout tourne.

Backend

  • Structure projet FastAPI (app/api/, app/core/, app/models/, app/schemas/, app/services/)
  • Configuration SQLAlchemy 2.0 async + pool de connexions
  • Création des schémas PostgreSQL (todos, shopping, notes) via Alembic
  • Migration initiale : toutes les tables (voir spec section 3)
  • Endpoint santé : GET /api/health
  • Module media (app/services/media.py) :
    • Validation des formats acceptés (JPG, PNG, SVG, WebP, WebM, M4A)
    • Génération miniature Pillow : 150×150 (shopping), 300×300 (notes), 400×300 (inline)
    • Sauvegarde originals/ + thumbnails/ sur le volume
    • Endpoint POST /api/media/upload → retourne { file_path, thumbnail_path }
    • Endpoint DELETE /api/media/{uuid} → supprime original + miniature
  • Middleware CORS pour réseau local 10.0.0.0/22
  • Configuration via variables d'environnement (.env)
  • Dockerfile backend (Python 3.12 slim)

Frontend

  • Scaffold Vite + React 18 + TypeScript
  • Tailwind CSS configuré avec les tokens Gruvbox (via tokens.json)
  • Intégration design_system/components/ui-kit.jsx
  • @vite-pwa/plugin configuré (Service Worker + manifest)
  • manifest.json avec icônes iOS + Android
  • Routage React Router v6
  • Layout de base : navigation mobile (bottom bar) + navigation laptop (sidebar)
  • Dockerfile frontend (Nginx + proxy /api/ → backend)
  • Favicon maison (SVG Gruvbox orange)

Infra

  • docker-compose.yml avec 3 services (frontend, backend, db)
  • Volume PostgreSQL persistant
  • Volume uploads persistant (/uploads/)
  • Fichier .env.example
  • Script de seed (backend/app/data/seed.py) : 113 produits + 9 magasins

Phase 2 — Module Todos

Objectif : créer, lister, modifier, terminer et reporter des tâches depuis mobile et laptop.

Backend

  • GET /api/todos — liste avec filtres (domaine, statut, priorité, tags, période)
  • POST /api/todos — création
  • PATCH /api/todos/{id} — mise à jour partielle
  • DELETE /api/todos/{id} — suppression
  • POST /api/todos/{id}/postpone — incrémente postponed_count + décale due_date
  • Schémas Pydantic : TodoCreate, TodoUpdate, TodoResponse
  • Tests d'intégration (9 tests)

Frontend Mobile

  • Page Todos : liste des tâches en cours, groupées par domaine
  • Bouton "+ Tâche" flottant → Modal création (titre + domaine + date + priorité + tags)
  • Double-tap → Modal édition pré-rempli
  • Swipe droite → marquer done
  • Swipe gauche → actions (reporter 1j / reporter 1 semaine / supprimer)
  • Badge compteur par domaine

Frontend Laptop

  • Vue tableau avec filtres : domaine, statut, priorité, période
  • Formulaire complet (tous les champs) via Modal
  • Double-clic sur titre → Modal édition
  • Actions inline : ✓ done / +1j / +1S / ✕ supprimer

Phase 3 — Module Shopping (liste de courses)

Objectif : liste de courses fonctionnelle en magasin depuis smartphone, avec génération automatique.

Backend

  • GET /api/shopping/stores — liste magasins
  • GET /api/shopping/products — catalogue avec recherche (param q)
  • GET /api/shopping/lists — listes de courses avec compteurs
  • POST /api/shopping/lists — création liste
  • GET /api/shopping/lists/{id} — détail liste avec articles
  • PATCH /api/shopping/lists/{id} — mise à jour liste
  • DELETE /api/shopping/lists/{id} — suppression
  • POST /api/shopping/lists/{id}/items — ajout article (produit catalogue ou custom)
  • PATCH /api/shopping/lists/{id}/items/{item_id} — cocher / modifier
  • DELETE /api/shopping/lists/{id}/items/{item_id} — suppression article
  • POST /api/shopping/lists/{id}/finish — terminer les courses (report articles non cochés → nouvelle liste draft avec carried_over=True)
  • POST /api/shopping/lists/generate — liste magique V1 (score = retard / intervalle moyen, articles cochés comme historique)
  • Schémas Pydantic complets (listes, articles, produits, magasins)
  • Tests d'intégration (10 tests)

Frontend

  • Page Shopping avec 3 vues : liste des listes / détail / mode magasin
  • Vue "listes" : cartes par liste (statut, compteur articles), FAB + bouton "Liste magique"
  • Bouton "Liste magique" : désactivé si une liste draft/active existe
  • Vue "détail" : articles avec swipe-to-delete, FAB ajout article, bouton ✏️ modal gestion
  • Modal ✏️ : ajout rapide d'article + bouton rouge "Supprimer la liste en cours"
  • Vue "Mode magasin" : plein écran, grands boutons (48px+), section cochés/non cochés
  • Wake Lock API activée automatiquement en mode magasin
  • Composant Modal générique réutilisable (overlay + Escape + stopPropagation)
  • Composant ItemRow : checkbox circulaire + swipe-to-delete + mode magasin
  • Hook useWakeLock avec fallback gracieux (mode économie d'énergie)
  • Client API TypeScript typé (frontend/src/api/shopping.ts)
  • Migration TodoForm vers Modal (plus de panneau inline)

Phase 4 — Module Notes

Objectif : saisie rapide de notes avec photo, audio et GPS depuis smartphone.

Backend

  • GET /api/notes — liste avec search full-text + filtres tags/catégorie
  • POST /api/notes — création
  • PATCH /api/notes/{id} — mise à jour
  • DELETE /api/notes/{id} — suppression
  • POST /api/notes/{id}/attachments — upload fichier (image/audio)
  • DELETE /api/notes/{id}/attachments/{att_id} — suppression pièce jointe
  • Compression image Pillow → WebP (service media partagé)
  • Recherche FTS PostgreSQL français

Frontend Mobile

  • Page Notes : liste chronologique avec aperçu
  • Bouton "+ Note" → formulaire rapide (contenu + tags) via Modal
  • Bouton 📷 → Camera API (capture directe ou import galerie)
  • Bouton 🎤 → MediaRecorder (enregistrement audio inline)
  • Bouton 📍 → Geolocation API → affichage coordonnées
  • Visionneuse photo inline + lecteur audio inline
  • Compression WebP côté client (Canvas API) — différé Phase 5+
  • Waveform visuel enregistrement — différé Phase 5+

Frontend Laptop

  • Grille notes avec vignettes photo
  • Recherche full-text
  • Filtres rapides : avec photo, avec audio, avec GPS
  • Vue carte pour les notes avec GPS (Leaflet.js) — différé Phase 5+

Phase 5 — Scan produits + enrichissement catalogue

Objectif : scan code-barres depuis mobile, auto-remplissage depuis OpenFoodFacts.

Services Docker

  • Dockerfile product-search/ : Python slim + requests + client OpenFoodFacts
  • Ajout service product-search dans docker-compose.yml (port 8002)
  • Ajout service searxng dans docker-compose.yml (images uniquement)

Backend (endpoints proxy)

  • GET /api/products/lookup?barcode= → proxifie vers product-search
  • GET /api/products/search?q= → proxifie vers product-search
  • POST /api/products/import → crée produit depuis données OpenFoodFacts

Frontend Mobile — scan

  • Intégration zxing-js (BarcodeReader via flux caméra)
  • Bouton "Scanner" dans le formulaire d'ajout de produit
  • Sur scan réussi → auto-remplissage formulaire

Frontend Laptop — enrichissement catalogue

  • CRUD complet produits dans catalogue
  • Recherche texte → OpenFoodFacts → import 1 clic
  • Gestion magasins

Phase 6 — Service OCR (conteneur dédié)

Objectif : OCR partagé, prérequis pour shopping avancé et notes avancées.

  • Dockerfile ocr/ : Python slim + Tesseract 5 + langues (fra, eng) + Pillow
  • POST /extract : reçoit image (multipart), retourne { text, confidence }
  • Endpoint backend POST /api/ocr/extract : proxifie vers ocr:8001
  • Ajout du service ocr dans docker-compose.yml

Phase 7 — Shopping avancé (OCR + suivi prix)

Backend

  • POST /api/shopping/ocr/price-tag — photo étiquette → extraction prix
  • POST /api/shopping/ocr/receipt — photo ticket → reconciliation liste
  • GET /api/shopping/products/{id}/price-history — historique prix par produit + magasin

Frontend

  • Bouton 📷 sur chaque article → OCR étiquette → pré-remplissage prix
  • Graphique d'évolution du prix par produit (Recharts)
  • Comparaison prix par magasin

Phase 8 — MCP Server

Objectif : exposer les outils HomeHub aux agents IA (Hermes, Claude, etc.).

  • Intégration SDK MCP Python (mcp package)
  • Endpoint SSE /mcp
  • Implémentation des outils : get_todos(), add_todo(), add_shopping_item(), search_notes()
  • Documentation OpenAPI des outils MCP

Phases futures (hors scope initial)

Phase 9 — Authentification multi-utilisateurs

  • Auth JWT (login / refresh token)
  • Activation de owner_id dans toutes les tables
  • Page connexion React

Phase 10 — Calendrier + intégrations

  • Sync Google Calendar (OAuth2 + worker)
  • Endpoint CalDAV pour iOS
  • Redis pour la queue de synchronisation
  • Webhooks Gitea → Kanban
  • Home Assistant : capteur "tâches en retard"

Phase 11 — Vision IA

  • Endpoint analyse frigo (photo → suggestions liste de courses)
  • Amélioration OCR via modèle Vision local (Ollama)

Ordre de développement

Phase 1 ✅ → Phase 2 ✅ → Phase 3 ✅ → Phase 4 (Notes) → Phase 5 (Scan) → Phase 6 (OCR) → Phase 7 (Shopping avancé) → Phase 8 (MCP)