From 22bcc727c9874c12d7f0e73238253784784fbcb2 Mon Sep 17 00:00:00 2001 From: Debian Dev4 Date: Mon, 22 Sep 2025 07:32:24 +0000 Subject: [PATCH] docs: add architecture, installation, deployment, functional, technical, flows, quality, security, TODO [skip ci] --- docs/ARCHITECTURE.md | 22 ++++++++++++++++++++++ docs/DEPLOIEMENT.md | 20 ++++++++++++++++++++ docs/FLUX.md | 6 ++++++ docs/FONCTIONNEL.md | 15 +++++++++++++++ docs/INSTALLATION.md | 26 ++++++++++++++++++++++++++ docs/QUALITE.md | 6 ++++++ docs/SECURITE.md | 6 ++++++ docs/TECHNIQUE.md | 19 +++++++++++++++++++ docs/TODO.md | 6 ++++++ 9 files changed, 126 insertions(+) create mode 100644 docs/ARCHITECTURE.md create mode 100644 docs/DEPLOIEMENT.md create mode 100644 docs/FLUX.md create mode 100644 docs/FONCTIONNEL.md create mode 100644 docs/INSTALLATION.md create mode 100644 docs/QUALITE.md create mode 100644 docs/SECURITE.md create mode 100644 docs/TECHNIQUE.md create mode 100644 docs/TODO.md diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md new file mode 100644 index 00000000..fdfb380f --- /dev/null +++ b/docs/ARCHITECTURE.md @@ -0,0 +1,22 @@ +# Architecture - LeCoffre Front + +## Composants +- Next.js (branche `ext`). +- Intègre `ihm_client` via iframe. + +## Dépendances +- Backend `lecoffre-back-mini` (`NEXT_PUBLIC_BACK_*`). +- Redirections IdNot (local.4nkweb.com:3000). + +## Réseau et ports +- Servi via Nginx: `https://dev4.4nkweb.com/lecoffre/`. + +## Variables d’environnement (centralisées) +- `NEXT_PUBLIC_*` depuis `lecoffre_node/.env.master`. + +## Monitoring +- Logs Promtail → Loki. +- Dashboard Grafana: Frontend Services. + +## Notes +- Pas de `.env` local, utilisation variables runtime. diff --git a/docs/DEPLOIEMENT.md b/docs/DEPLOIEMENT.md new file mode 100644 index 00000000..8e831d12 --- /dev/null +++ b/docs/DEPLOIEMENT.md @@ -0,0 +1,20 @@ +# Déploiement - LeCoffre Front + +## Préparation +- Branche `ext`. +- `NEXT_PUBLIC_*` dans `lecoffre_node/.env.master`. + +## Déploiement (orchestrateur) +```bash +cd /home/debian/4NK_env/lecoffre_node +./scripts/start.sh | cat +./scripts/validate-deployment.sh | cat +``` + +## Vérifications +- `https://dev4.4nkweb.com/lecoffre/` s'affiche. +- Iframe `ihm_client` s'ouvre. + +## Règles +- Pas de compose direct. +- Push `ext` sans CI pour docs. diff --git a/docs/FLUX.md b/docs/FLUX.md new file mode 100644 index 00000000..570e9e52 --- /dev/null +++ b/docs/FLUX.md @@ -0,0 +1,6 @@ +# Description des Flux - LeCoffre Front + +## Flux principaux +1. Auth notaire: Front → IdNot → Front (callback). +2. Intégration IHM: Front → iframe → IHM. +3. API: Front → Back (REST). diff --git a/docs/FONCTIONNEL.md b/docs/FONCTIONNEL.md new file mode 100644 index 00000000..dc862722 --- /dev/null +++ b/docs/FONCTIONNEL.md @@ -0,0 +1,15 @@ +# Description Fonctionnelle - LeCoffre Front + +## Objectif +Fournir l’interface principale (Next.js) orchestrant l’UX, incluant l’iframe IHM Client. + +## Parcours clés +- Authentification notaire (redirections IdNot). +- Navigation dossiers et intégration iframe IHM. +- Appels API backend, feedback utilisateur et gestion d’erreurs. + +## Rôles +- Notaire, utilisateur interne. + +## Résultats attendus +- UX fluide, chargements différés (code splitting), gestion session robuste. diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md new file mode 100644 index 00000000..8f999a33 --- /dev/null +++ b/docs/INSTALLATION.md @@ -0,0 +1,26 @@ +# Installation - LeCoffre Front + +## Prérequis +- Dépôts sous `/home/debian/4NK_env` (branche `ext`). +- Docker/Compose. +- Variables `NEXT_PUBLIC_*` dans `lecoffre_node/.env.master`. + +## Configuration +- Pas de `.env` local. +- Vérifier URLs backend et iframe IHM. + +## Démarrage (orchestrateur) +```bash +cd /home/debian/4NK_env/lecoffre_node +./scripts/start.sh | cat +``` + +## Accès +- `https://dev4.4nkweb.com/lecoffre/` + +## Vérifications +- Ouverture iframe IHM. +- Appels API vers `/api/` OK. + +## Notes +- CI via tag `ext`. diff --git a/docs/QUALITE.md b/docs/QUALITE.md new file mode 100644 index 00000000..055769dc --- /dev/null +++ b/docs/QUALITE.md @@ -0,0 +1,6 @@ +# Qualité Logicielle - LeCoffre Front + +- Lint/format: respecter règles Next/TS. +- Tests: E2E parcours IdNot et iframe IHM. +- Performance: audit Lighthouse, lazy loading. +- Observabilité: logs client minimaux, erreurs capturées. diff --git a/docs/SECURITE.md b/docs/SECURITE.md new file mode 100644 index 00000000..5b126d95 --- /dev/null +++ b/docs/SECURITE.md @@ -0,0 +1,6 @@ +# Sécurité - LeCoffre Front + +- Aucune donnée sensible côté client. +- Variables exposées en `NEXT_PUBLIC_*` contrôlées. +- CSP/headers via Nginx. +- Sanitation des entrées utilisateur. diff --git a/docs/TECHNIQUE.md b/docs/TECHNIQUE.md new file mode 100644 index 00000000..7733923e --- /dev/null +++ b/docs/TECHNIQUE.md @@ -0,0 +1,19 @@ +# Description Technique - LeCoffre Front + +## Tech stack +- Next.js, Node.js 19. + +## Configuration +- Variables `NEXT_PUBLIC_*` via `lecoffre_node/.env.master`. + +## Interfaces +- Iframe vers `ihm_client`. +- REST vers `/api/`. + +## Sécurité +- Aucun secret côté client. +- Headers via Nginx. + +## Observabilité +- Logs Promtail → Loki. +- Dashboards Grafana. diff --git a/docs/TODO.md b/docs/TODO.md new file mode 100644 index 00000000..5fae7fcf --- /dev/null +++ b/docs/TODO.md @@ -0,0 +1,6 @@ +# TODO - LeCoffre Front + +- Vérifier URLs backend et iframe IHM. +- Tester parcours IdNot. +- Valider variables `NEXT_PUBLIC_*`. +- Vérifier dashboards Grafana Frontend.