docs: add architecture, installation, deployment, functional, technical, flows, quality, security, TODO [skip ci]
This commit is contained in:
parent
087ea0b2c3
commit
22bcc727c9
22
docs/ARCHITECTURE.md
Normal file
22
docs/ARCHITECTURE.md
Normal file
@ -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.
|
20
docs/DEPLOIEMENT.md
Normal file
20
docs/DEPLOIEMENT.md
Normal file
@ -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.
|
6
docs/FLUX.md
Normal file
6
docs/FLUX.md
Normal file
@ -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).
|
15
docs/FONCTIONNEL.md
Normal file
15
docs/FONCTIONNEL.md
Normal file
@ -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.
|
26
docs/INSTALLATION.md
Normal file
26
docs/INSTALLATION.md
Normal file
@ -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`.
|
6
docs/QUALITE.md
Normal file
6
docs/QUALITE.md
Normal file
@ -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.
|
6
docs/SECURITE.md
Normal file
6
docs/SECURITE.md
Normal file
@ -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.
|
19
docs/TECHNIQUE.md
Normal file
19
docs/TECHNIQUE.md
Normal file
@ -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.
|
6
docs/TODO.md
Normal file
6
docs/TODO.md
Normal file
@ -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.
|
Loading…
x
Reference in New Issue
Block a user