4c48ee5fe4
- Suppression de 10 fichiers obsolètes (scripts, tests, docs temporaires) - Suppression des dossiers vides (frontend/src, backend/src/middlewares) - Réecriture complète de 7 fichiers de documentation - README.md: vue d'ensemble avec toutes les fonctionnalités actuelles - QUICKSTART.md: guide de démarrage rapide en 3 étapes - CONFIGURATION.md: guide de configuration complète (Docker, RCON, sécurité) - DEPLOYMENT.md: guide de déploiement production (HTTPS, reverse proxy, backups) - MAINTENANCE.md: guide de maintenance avec dépannage exhaustif - INDEX.md: index de navigation simplifié - CHANGELOG.md: historique complet v1.0.0 - Optimisation docker-compose.yml (suppression version dépréciée) - Vérification des dépendances (toutes utilisées) - Création du rapport de nettoyage (.cleanup-report.md) - Documentation cohérente avec le code actuel - Projet 100% prêt pour la production
104 lines
3.3 KiB
Markdown
104 lines
3.3 KiB
Markdown
# Index de la Documentation
|
|
|
|
Documentation complète du panel web d'administration NationsGlory.
|
|
|
|
## 📖 Documents Disponibles
|
|
|
|
### 🚀 Démarrage
|
|
- **[README.md](README.md)** - Vue d'ensemble du projet et fonctionnalités
|
|
- **[QUICKSTART.md](QUICKSTART.md)** - Guide de démarrage rapide (5 minutes)
|
|
|
|
### ⚙️ Configuration & Déploiement
|
|
- **[CONFIGURATION.md](CONFIGURATION.md)** - Configuration détaillée
|
|
- **[DEPLOYMENT.md](DEPLOYMENT.md)** - Guide de déploiement en production
|
|
|
|
### 🔧 Maintenance & Suivi
|
|
- **[MAINTENANCE.md](MAINTENANCE.md)** - Maintenance, backups et dépannage
|
|
- **[CHANGELOG.md](CHANGELOG.md)** - Historique complet des versions
|
|
|
|
## 🎯 Guide de Lecture Recommandé
|
|
|
|
### Pour démarrer rapidement
|
|
1. [README.md](README.md) - Comprendre le projet
|
|
2. [QUICKSTART.md](QUICKSTART.md) - Installation en 3 étapes
|
|
3. Tester le panel sur http://localhost:4001
|
|
|
|
### Pour une installation complète
|
|
1. [CONFIGURATION.md](CONFIGURATION.md) - Paramétrage détaillé
|
|
2. [DEPLOYMENT.md](DEPLOYMENT.md) - Déploiement production
|
|
3. [MAINTENANCE.md](MAINTENANCE.md) - Maintenance quotidienne
|
|
|
|
### Pour le développement
|
|
1. [README.md](README.md) - Architecture et stack technique
|
|
2. [CHANGELOG.md](CHANGELOG.md) - Historique des modifications
|
|
3. Code source dans `backend/` et `frontend/`
|
|
|
|
## 📂 Structure du Projet
|
|
|
|
\`\`\`
|
|
WebNationsGlory_ServeurBuild_Red/
|
|
├── README.md # Vue d'ensemble
|
|
├── QUICKSTART.md # Démarrage rapide
|
|
├── CONFIGURATION.md # Configuration
|
|
├── DEPLOYMENT.md # Déploiement
|
|
├── MAINTENANCE.md # Maintenance
|
|
├── CHANGELOG.md # Versions
|
|
├── INDEX.md # Ce fichier
|
|
├── docker-compose.yml # Orchestration Docker
|
|
├── Dockerfile # Image Docker
|
|
├── backend/ # API Node.js
|
|
│ ├── src/
|
|
│ │ ├── routes/ # Endpoints API
|
|
│ │ ├── utils/ # Client RCON
|
|
│ │ └── server.js # Serveur Express
|
|
│ └── data/ # Données (users.json)
|
|
└── frontend/ # Interface web
|
|
└── public/
|
|
├── css/ # Styles
|
|
├── js/ # Application SPA
|
|
└── index.html # Point d'entrée
|
|
\`\`\`
|
|
|
|
## 🔗 Liens Rapides
|
|
|
|
### Commandes Docker
|
|
\`\`\`bash
|
|
docker-compose up -d # Démarrer
|
|
docker-compose down # Arrêter
|
|
docker-compose logs -f app # Voir les logs
|
|
docker-compose restart app # Redémarrer
|
|
\`\`\`
|
|
|
|
### URLs Importantes
|
|
- Panel Web : http://localhost:4001
|
|
- RCON : localhost:25575
|
|
- Serveur Minecraft : selon votre configuration
|
|
|
|
### Fichiers de Configuration
|
|
- \`docker-compose.yml\` - Configuration Docker
|
|
- \`backend/src/server.js\` - Configuration Express
|
|
- \`SERVER_DIR/server.properties\` - Configuration Minecraft
|
|
|
|
## 📝 Contribution
|
|
|
|
Pour toute modification :
|
|
1. Éditer les fichiers appropriés
|
|
2. Tester localement avec Docker
|
|
3. Mettre à jour [CHANGELOG.md](CHANGELOG.md)
|
|
4. Commit et push
|
|
|
|
## ⚠️ Important
|
|
|
|
- Compatible uniquement avec **Minecraft 1.6.4**
|
|
- Nécessite **Docker & Docker Compose**
|
|
- Seuls les **OPs** peuvent se connecter
|
|
- Le serveur Minecraft doit être **démarré avant** le panel
|
|
|
|
## 📄 Licence
|
|
|
|
Projet privé - NationsGlory Server
|
|
|
|
---
|
|
|
|
Dernière mise à jour : 04/02/2025
|