Actualiser README.md

This commit is contained in:
Stéphan Peccini 2025-05-02 22:42:13 +02:00
parent 5436ccff5e
commit b1d05263e1

View File

@ -30,14 +30,13 @@ Le fichier **requirements.txt** permet d'installer tout ce qui est nécessaire p
### Environnement
Le fichier **.env** n'est pas dans le dépôt car il contient la clé pour accéder au backend.
Le fichier **.env.local** qui contient GITEA_TOKEN n'est pas dans le dépôt car il contient la clé pour accéder au backend.
Pour l'environnement de pré-production, (https://fabnum-dev.peccini.fr)[https://fabnum-dev.peccini.fr] :
ENV=dev
PORT=8502
GITEA_URL = "https://fabnum-git.peccini.fr/api/v1"
GITEA_TOKEN = "LE_TOKEN_POUR_ACCEDER_A_GITEA"
ORGANISATION = "fabnum"
DEPOT_FICHES = "fiches"
@ -86,3 +85,45 @@ Il s'y connecte aussi pour récupérer les fiches et les présenter.
### tickets_fiche.py
Ce script est invoqué par fabnum.py pour assurer la coopération avec les internautes. Il permet de se connecter au backend Gitea pour récupérer les tickets associés à une fiche, les présenter ou en créée un nouveau.
### Organisation du code
fabnum_app/
├──  fabnum.py                       # Point d'entrée principal
├── config.py                           # Chargement des variables denvironnement
├── utils/
│ ├── gitea.py                          # Connexion API Gitea
│ ├── graph_utils.py               # Chemins, criticité, extraction de données
│ └── visualisation.py            # Graphiques Altair, Plotly
├── components/
│ ├── sidebar.py                     # Menu latéral
│ ├── header.py                     # En-tête HTML
│ ├── footer.py                       # Pied de page
│ └── fiches.py                      # Lecture et affichage des fiches
├── tickets_fiche.py              # Gestion des tickets associés aux fiches
├── assets/
│ ├── styles.css                     # Feuille de style personnalisée
│ └── impact_co2.js             # Script pour calcul dimpact environnemental
├── .env                                 # Configuration versionnée (sans secrets)
├── .env.local                        # Configuration locale (non versionnée)
├── .gitignore                       # Exclusion des fichiers sensibles
└── requirements.txt          # Dépendances Python