docs: add architecture, installation, deployment, functional, technical, flows, quality, security, TODO [skip ci]

This commit is contained in:
4NK CI Bot 2025-09-22 07:31:22 +00:00
parent 81e52c1da4
commit 1bc594fa90
9 changed files with 149 additions and 0 deletions

23
docs/ARCHITECTURE.md Normal file
View File

@ -0,0 +1,23 @@
# Architecture - IHM Client
## Composants
- Frontend embarqué en iframe dans `lecoffre-front`.
- Dialogue avec `sdk_signer` et `sdk_relay` via WebSocket.
## Dépendances
- `sdk_signer` via `VITE_SIGNER_URL`.
- `sdk_relay` via `VITE_WS_URL`.
- Backend `lecoffre-back-mini` via `VITE_API_BASE_URL`.
## Réseau et ports
- Exposé derrière Nginx via `https://dev4.4nkweb.com/`.
## Variables denvironnement (centralisées)
- Chargement depuis `lecoffre_node/.env.master`.
## Monitoring
- Logs → Promtail → Loki → Grafana (Frontend Services).
## Notes
- Code splitting (`React.lazy`, `Suspense`).
- Pas de `.env` local, configuration via Docker Compose.

23
docs/DEPLOIEMENT.md Normal file
View File

@ -0,0 +1,23 @@
# Déploiement - IHM Client
## Préparation
- Branche `ext` sur tous les dépôts.
- Variables dans `lecoffre_node/.env.master` (pas de `.env` local).
- Ne pas utiliser `docker compose up -d`.
## 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/` (iframe OK)
- WS `wss://dev4.4nkweb.com/ws/`
- `./scripts/monitor-progress.sh | cat`
## Règles
- Pousser sur `ext` sans déclencher de CI tant que non nécessaire.
- Config centralisée uniquement.
- Logs via Promtail → Loki → Grafana.

10
docs/FLUX.md Normal file
View File

@ -0,0 +1,10 @@
# Description des Flux - IHM Client
```mermaid
documentation
```
## Flux principaux
1. Auth notaire via front → IdNot → front → iframe IHM.
2. IHM ↔ Signer (opérations signées).
3. IHM ↔ Relay (WebSocket) pour évènements.

18
docs/FONCTIONNEL.md Normal file
View File

@ -0,0 +1,18 @@
# Description Fonctionnelle - IHM Client
## Objectif
Fournir linterface dinteraction utilisateur (iframe) pour les flux métiers et les opérations liées aux clés Bitcoin (Silent Payment).
## Parcours clés
- Authentification via redirection IdNot (depuis `lecoffre-front`).
- Connexion au `sdk_signer` pour opérations signées.
- Échanges temps réel via `sdk_relay` (WebSocket).
## Rôles
- Notaire: initie les dossiers, suit létat.
- Client: accède aux dossiers, valide via SMS, téléverse des pièces.
## Résultats attendus
- Affichage fiable de liframe.
- Opérations signées validées.
- Erreurs affichées à lutilisateur, logs collectés.

35
docs/INSTALLATION.md Normal file
View File

@ -0,0 +1,35 @@
# Installation - IHM Client
## Prérequis
- Accès au dépôt `4NK_env` (branche `ext`).
- Docker/Compose installés.
- Variables centralisées dans `lecoffre_node/.env.master`.
## Récupération du code
```bash
cd /home/debian/4NK_env
# Assure-toi d'être sur la branche ext dans tous les dépôts
```
## Configuration
- Ne pas créer de `.env` local.
- Renseigner/valider `VITE_*` dans `lecoffre_node/.env.master`.
## Démarrage (via orchestrateur)
- Lancer via `lecoffre_node` (recommandé) :
```bash
cd /home/debian/4NK_env/lecoffre_node
./scripts/start.sh | cat
```
## Accès
- `https://dev4.4nkweb.com/` (intégré via Nginx).
## Vérifications
- Page statut: `https://dev4.4nkweb.com/status/`
- WebSocket: `wss://dev4.4nkweb.com/ws/`
- Logs Grafana.
## Notes
- Brancher IHM via iframe dans `lecoffre-front`.
- Ne pas déclencher de CI depuis ce dépôt; builds images depuis pipelines tag `ext` si nécessaire.

6
docs/QUALITE.md Normal file
View File

@ -0,0 +1,6 @@
# Qualité Logicielle - IHM Client
- Lint/format: respecter config projet.
- Tests: ajouter vérifs WS et intégration iframe.
- Performance: code splitting et lazy loading.
- Observabilité: logs structurés, erreurs gérées.

6
docs/SECURITE.md Normal file
View File

@ -0,0 +1,6 @@
# Sécurité - IHM Client
- Pas de secrets dans le code/dépôt.
- Variables via `.env.master` uniquement.
- CSP/headers via Nginx.
- WS sécurisé via `wss://`.

22
docs/TECHNIQUE.md Normal file
View File

@ -0,0 +1,22 @@
# Description Technique - IHM Client
## Tech stack
- Node.js 20, Vite/React.
- Code splitting (`React.lazy`, `Suspense`).
## Configuration
- Variables `VITE_*` via `lecoffre_node/.env.master`.
- Aucune lecture de `.env` local.
## Interfaces
- WebSocket `VITE_WS_URL` (relay).
- REST `VITE_API_BASE_URL` (backend).
- `VITE_SIGNER_URL` (signer).
## Sécurité
- Aucune clé en dépôt.
- Headers sécurisés via Nginx.
## Observabilité
- Logs Promtail → Loki.
- Dashboards Grafana.

6
docs/TODO.md Normal file
View File

@ -0,0 +1,6 @@
# TODO - IHM Client
- Vérifier intégration iframe avec `lecoffre-front`.
- Tester WS `wss://dev4.4nkweb.com/ws/`.
- Vérifier configuration `VITE_*` via `.env.master`.
- Ajouter dashboards Grafana si manquants.