generated from gilles/template-webapp
62 lines
2.4 KiB
Markdown
62 lines
2.4 KiB
Markdown
# À LIRE — Initialisation du projet
|
|
|
|
Ce dépôt est basé sur le template **template-webapp**.
|
|
|
|
## Étapes obligatoires
|
|
|
|
1. Renommer le projet (repo, README, docker-compose)
|
|
2. Compléter les fichiers de contexte et de vision
|
|
3. Lire `docs/ARCHITECTURE.md` avant toute écriture de code
|
|
|
|
---
|
|
|
|
## Légende des zones
|
|
- `<A REMPLIR - PROJET> (exemple: à personnaliser — a supprimer)` : à compléter par toi selon le projet.
|
|
- `<A COMPLETER PAR AGENT>` : à compléter par un agent spécialisé architecture / dev.
|
|
|
|
---
|
|
|
|
## 1. Description du projet
|
|
|
|
- Nom du projet : HomeStock <!-- complété par codex -->
|
|
- Type de webapp : Application web self-hosted mono-utilisateur <!-- complété par codex -->
|
|
- Public cible : Particulier gérant son inventaire domestique <!-- complété par codex -->
|
|
- Objectif principal : Cataloguer et gérer l'inventaire complet de la maison (équipements, matériels, consommables) avec suivi précis des emplacements, documents et états <!-- complété par codex -->
|
|
|
|
---
|
|
|
|
## 2. Contraintes fortes
|
|
|
|
- Self-hosted / Cloud : Self-hosted (déploiement local sur le réseau domestique) <!-- complété par codex -->
|
|
- Mono-utilisateur / Multi-utilisateur : Mono-utilisateur <!-- complété par codex -->
|
|
- Données sensibles : Non (données personnelles mais non sensibles : inventaire domestique, factures)
|
|
- Contraintes légales : Aucune contrainte légale stricte (usage personnel, pas de traitement de données tierces) <!-- complété par codex -->
|
|
|
|
---
|
|
|
|
## 3. Stack envisagée (indicative)
|
|
|
|
- Frontend : React 18+ avec Vite, TanStack Query (React Query), React Router, TailwindCSS <!-- complété par codex -->
|
|
- Backend : Python 3.11+ avec FastAPI, Pydantic pour validation, SQLAlchemy comme ORM <!-- complété par codex -->
|
|
- Base de données : SQLite (fichier local, adapté au mono-utilisateur) <!-- complété par codex -->
|
|
- Stockage fichiers : Système de fichiers local (dossier uploads/ avec organisation par type) <!-- complété par codex -->
|
|
|
|
---
|
|
|
|
## 4. Règles non négociables
|
|
|
|
- Monolithe modulaire (un seul dépôt, modules séparés)
|
|
- ADR obligatoire pour toute décision structurante (ADR = Architecture Decision Record)
|
|
- Backlog produit avant toute implémentation
|
|
|
|
---
|
|
|
|
## 5. Démarrage rapide
|
|
|
|
- Compléter `PROJECT_CONTEXT.md`
|
|
- Compléter `product/VISION.md`
|
|
- Compléter `docs/ARCHITECTURE.md`
|
|
- Créer les premières REQ (exigences) dans `product/BACKLOG.md`
|
|
- Documenter les outils dans `outils_dev_pref.md`
|
|
|
|
--- |