Bruno Charest
984d06a223
Some checks failed
Tests / Backend Tests (Python) (3.10) (push) Has been cancelled
Tests / Backend Tests (Python) (3.11) (push) Has been cancelled
Tests / Backend Tests (Python) (3.12) (push) Has been cancelled
Tests / Frontend Tests (JS) (push) Has been cancelled
Tests / Integration Tests (push) Has been cancelled
Tests / All Tests Passed (push) Has been cancelled
52 lines
1.9 KiB
Markdown
52 lines
1.9 KiB
Markdown
# 📊 Explorateur de Schéma Interactive
|
|
|
|
Ce répertoire contient un outil de documentation interactif permettant de visualiser et de naviguer dans le schéma de la base de données de l'application.
|
|
|
|
## 🔍 À propos de l'outil
|
|
|
|
Le fichier `database_schema_explorer.jsx` est une application React autonome qui :
|
|
- Listes toutes les tables par catégorie (Docker, Ansible, Système, etc.).
|
|
- Affiche les détails complets des colonnes (types, pk, fk, nullable, valeurs par défaut).
|
|
- Propose une interface moderne avec recherche temps réel et filtrage par groupes.
|
|
|
|
## 🚀 Comment l'exécuter
|
|
|
|
### Méthode 1 : Zéro-Installation (La plus rapide pour consulter)
|
|
Si vous ne souhaitez pas installer de nouvelles dépendances Node.js, ouvrez simplement le fichier suivant dans votre navigateur :
|
|
|
|
📄 `docs/database/standalone.html`
|
|
|
|
*Note : Cette méthode utilise des bibliothèques via CDN (React + Babel Standalone) pour transpiler le JSX à la volée directement dans le navigateur. C'est idéal pour une consultation ponctuelle.*
|
|
|
|
### Méthode 2 : Méthode Professionnelle (Vite)
|
|
C'est la méthode recommandée pour un développement fluide avec Hot Module Replacement (HMR).
|
|
|
|
1. **Installer les dépendances** :
|
|
```powershell
|
|
npm install react react-dom
|
|
npm install -D vite @vitejs/plugin-react
|
|
```
|
|
|
|
2. **Lancer l'explorateur** :
|
|
```powershell
|
|
npx vite docs/database
|
|
```
|
|
|
|
👉 L'application sera disponible sur `http://localhost:5173`.
|
|
|
|
## 🛠️ Configuration d'entrée
|
|
|
|
Un fichier `index.html` est présent dans ce répertoire pour servir de point d'entrée. Il charge dynamiquement le composant React et le monte dans la page.
|
|
|
|
## 💡 Astuce de Productivité
|
|
|
|
Vous pouvez ajouter un raccourci dans votre `package.json` pour un accès rapide :
|
|
|
|
```json
|
|
"scripts": {
|
|
"docs:db": "vite docs/database"
|
|
}
|
|
```
|
|
|
|
Cela vous permettra de lancer l'outil simplement avec : `npm run docs:db`.
|