From c4fd1e880aea4139fff1aebe1e213886aaaeeafd Mon Sep 17 00:00:00 2001 From: Gilles Soulier Date: Tue, 27 Jan 2026 19:54:16 +0100 Subject: [PATCH] chore: initialisation du template-webapp --- README.md => .editorconfig | 0 .env.example | 0 .gitignore | 0 LICENSE | 0 Makefile | 0 a-lire.md | 52 ++++++++++++++++++++ backend/CONTEXT.md | 0 backend/Dockerfile | 0 contracts/data_model.md | 0 contracts/errors.md | 0 contracts/import/examples/import_full.json | 0 contracts/import/examples/import_min.json | 0 contracts/import/import.schema.json | 28 +++++++++++ contracts/openapi.yaml | 0 contracts/pagination.md | 0 docker-compose.yml | 0 docs/API.md | 0 docs/ARCHITECTURE.md | 0 docs/DEPLOYMENT.md | 0 docs/OPERATIONS.md | 0 docs/PR_CHECKLIST.md | 0 docs/SECURITY.md | 0 docs/STYLEGUIDE.md | 0 docs/adr/0001-exemple.md | 0 docs/adr/TEMPLATE.md | 16 +++++++ frontend/CONTEXT.md | 0 frontend/Dockerfile | 0 outils_dev_pref.md | 55 ++++++++++++++++++++++ product/BACKLOG.md | 19 ++++++++ product/RELEASE_NOTES.md | 0 product/ROADMAP.md | 0 product/VISION.md | 0 scripts/db/backup.sh | 0 scripts/db/restore.sh | 0 scripts/dev.sh | 0 scripts/fmt.sh | 0 scripts/lint.sh | 0 scripts/test.sh | 0 tasks/001-exemple.md | 0 tasks/TEMPLATE.md | 26 ++++++++++ 40 files changed, 196 insertions(+) rename README.md => .editorconfig (100%) create mode 100644 .env.example create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 a-lire.md create mode 100644 backend/CONTEXT.md create mode 100644 backend/Dockerfile create mode 100644 contracts/data_model.md create mode 100644 contracts/errors.md create mode 100644 contracts/import/examples/import_full.json create mode 100644 contracts/import/examples/import_min.json create mode 100644 contracts/import/import.schema.json create mode 100644 contracts/openapi.yaml create mode 100644 contracts/pagination.md create mode 100644 docker-compose.yml create mode 100644 docs/API.md create mode 100644 docs/ARCHITECTURE.md create mode 100644 docs/DEPLOYMENT.md create mode 100644 docs/OPERATIONS.md create mode 100644 docs/PR_CHECKLIST.md create mode 100644 docs/SECURITY.md create mode 100644 docs/STYLEGUIDE.md create mode 100644 docs/adr/0001-exemple.md create mode 100644 docs/adr/TEMPLATE.md create mode 100644 frontend/CONTEXT.md create mode 100644 frontend/Dockerfile create mode 100644 outils_dev_pref.md create mode 100644 product/BACKLOG.md create mode 100644 product/RELEASE_NOTES.md create mode 100644 product/ROADMAP.md create mode 100644 product/VISION.md create mode 100755 scripts/db/backup.sh create mode 100755 scripts/db/restore.sh create mode 100755 scripts/dev.sh create mode 100755 scripts/fmt.sh create mode 100755 scripts/lint.sh create mode 100755 scripts/test.sh create mode 100644 tasks/001-exemple.md create mode 100644 tasks/TEMPLATE.md diff --git a/README.md b/.editorconfig similarity index 100% rename from README.md rename to .editorconfig diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..e69de29 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e69de29 diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e69de29 diff --git a/a-lire.md b/a-lire.md new file mode 100644 index 0000000..f177c01 --- /dev/null +++ b/a-lire.md @@ -0,0 +1,52 @@ +# À 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 sections ci-dessous +3. Lire `docs/ARCHITECTURE.md` avant toute écriture de code + +--- + +## 1. Description du projet + +- Nom du projet : +- Type de webapp : +- Public cible : +- Objectif principal : + +--- + +## 2. Contraintes fortes + +- Self-hosted / Cloud : +- Mono-utilisateur / Multi-utilisateur : +- Données sensibles : oui / non +- Contraintes légales (RGPD, etc.) : + +--- + +## 3. Stack envisagée (indicative) + +- Frontend : +- Backend : +- Base de données : +- Stockage fichiers : + +--- + +## 4. Règles non négociables + +- Monolithe modulaire +- ADR obligatoire pour toute décision structurante +- Backlog produit avant toute implémentation + +--- + +## 5. Démarrage rapide + +- Compléter `product/VISION.md` +- Compléter `docs/ARCHITECTURE.md` +- Créer les premières REQ dans `product/BACKLOG.md` \ No newline at end of file diff --git a/backend/CONTEXT.md b/backend/CONTEXT.md new file mode 100644 index 0000000..e69de29 diff --git a/backend/Dockerfile b/backend/Dockerfile new file mode 100644 index 0000000..e69de29 diff --git a/contracts/data_model.md b/contracts/data_model.md new file mode 100644 index 0000000..e69de29 diff --git a/contracts/errors.md b/contracts/errors.md new file mode 100644 index 0000000..e69de29 diff --git a/contracts/import/examples/import_full.json b/contracts/import/examples/import_full.json new file mode 100644 index 0000000..e69de29 diff --git a/contracts/import/examples/import_min.json b/contracts/import/examples/import_min.json new file mode 100644 index 0000000..e69de29 diff --git a/contracts/import/import.schema.json b/contracts/import/import.schema.json new file mode 100644 index 0000000..baaa4d6 --- /dev/null +++ b/contracts/import/import.schema.json @@ -0,0 +1,28 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "title": "Import Item", + "type": "object", + "required": ["source", "item"], + "properties": { + "source": { + "type": "object", + "properties": { + "name": {"type": "string"}, + "imported_at": {"type": "string", "format": "date-time"} + } + }, + "item": { + "type": "object", + "required": ["name", "domain"], + "properties": { + "name": {"type": "string"}, + "domain": {"type": "string"}, + "description": {"type": "string"}, + "specs": { + "type": "object", + "additionalProperties": true + } + } + } + } +} \ No newline at end of file diff --git a/contracts/openapi.yaml b/contracts/openapi.yaml new file mode 100644 index 0000000..e69de29 diff --git a/contracts/pagination.md b/contracts/pagination.md new file mode 100644 index 0000000..e69de29 diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..e69de29 diff --git a/docs/API.md b/docs/API.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/OPERATIONS.md b/docs/OPERATIONS.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/PR_CHECKLIST.md b/docs/PR_CHECKLIST.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/SECURITY.md b/docs/SECURITY.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/STYLEGUIDE.md b/docs/STYLEGUIDE.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/adr/0001-exemple.md b/docs/adr/0001-exemple.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/adr/TEMPLATE.md b/docs/adr/TEMPLATE.md new file mode 100644 index 0000000..aad6f2c --- /dev/null +++ b/docs/adr/TEMPLATE.md @@ -0,0 +1,16 @@ +# ADR-XXXX — + +- Statut : proposed | accepted | deprecated +- Date : YYYY-MM-DD + +## Contexte + +## Décision + +## Alternatives considérées + +## Conséquences + +## Impacts techniques + +## Notes \ No newline at end of file diff --git a/frontend/CONTEXT.md b/frontend/CONTEXT.md new file mode 100644 index 0000000..e69de29 diff --git a/frontend/Dockerfile b/frontend/Dockerfile new file mode 100644 index 0000000..e69de29 diff --git a/outils_dev_pref.md b/outils_dev_pref.md new file mode 100644 index 0000000..03cf6ab --- /dev/null +++ b/outils_dev_pref.md @@ -0,0 +1,55 @@ +# Outils & préférences de développement + +Ce fichier décrit **mes outils habituels** et **mes préférences**. +Il sert de référence aux agents et aux contributeurs. + +--- + +## Environnement de développement + +- OS principal : debian 13 +- Éditeur / IDE : VS Code +- Shell : +- Terminal : + +--- + +## Outils backend + +- Langage principal :python, go +- Framework API : +- ORM / DB access : +- Outils de test : +- Outils de lint / format : + +--- + +## Outils frontend + +- Framework UI : +- Bundler : +- Gestion état : +- Tests UI / E2E : + +--- + +## Préférences UI / Web + +- Thème préféré : gruvbox, dark, vintage - monokai dark +- Couleurs dominantes : +- Style UI : (minimal, dense, dashboard, etc.) +- Accessibilité prioritaire : oui / non + +--- + +## Outils DevOps + +- Conteneurs : Docker version 29.1.5 et ulterieur +- CI : +- Gestion secrets : + +--- + +## Notes + +Tout outil ajouté ici est **autorisé par défaut** dans le projet. \ No newline at end of file diff --git a/product/BACKLOG.md b/product/BACKLOG.md new file mode 100644 index 0000000..1c2185a --- /dev/null +++ b/product/BACKLOG.md @@ -0,0 +1,19 @@ +# Product Backlog + +## Statuts +proposed | accepted | planned | in_progress | done | rejected + +## Priorités +Must | Should | Could | Won’t + +--- + +### REQ-XXX — +- Description : +- Valeur utilisateur : +- Inclus / Exclus : +- Priorité : +- Statut : +- Impacts (FE/BE/DB/Arch) : +- Dépendances : +- Notes : \ No newline at end of file diff --git a/product/RELEASE_NOTES.md b/product/RELEASE_NOTES.md new file mode 100644 index 0000000..e69de29 diff --git a/product/ROADMAP.md b/product/ROADMAP.md new file mode 100644 index 0000000..e69de29 diff --git a/product/VISION.md b/product/VISION.md new file mode 100644 index 0000000..e69de29 diff --git a/scripts/db/backup.sh b/scripts/db/backup.sh new file mode 100755 index 0000000..e69de29 diff --git a/scripts/db/restore.sh b/scripts/db/restore.sh new file mode 100755 index 0000000..e69de29 diff --git a/scripts/dev.sh b/scripts/dev.sh new file mode 100755 index 0000000..e69de29 diff --git a/scripts/fmt.sh b/scripts/fmt.sh new file mode 100755 index 0000000..e69de29 diff --git a/scripts/lint.sh b/scripts/lint.sh new file mode 100755 index 0000000..e69de29 diff --git a/scripts/test.sh b/scripts/test.sh new file mode 100755 index 0000000..e69de29 diff --git a/tasks/001-exemple.md b/tasks/001-exemple.md new file mode 100644 index 0000000..e69de29 diff --git a/tasks/TEMPLATE.md b/tasks/TEMPLATE.md new file mode 100644 index 0000000..8ca307b --- /dev/null +++ b/tasks/TEMPLATE.md @@ -0,0 +1,26 @@ +# TASK-XXX — + +## Références +- PROJECT_CONTEXT.md +- docs/ARCHITECTURE.md +- product/BACKLOG.md → REQ-XXX + +## Objectif + +## Non-objectifs + +## Périmètre + +## Description fonctionnelle + +## Spécifications techniques + +## Fichiers autorisés + +## Critères d’acceptation + +## Tests + +## Risques + +## Sortie attendue \ No newline at end of file