FootballStatsAPI/README.md
2026-05-03 22:33:49 +02:00

148 lines
3.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="fr">
<head>
<meta charset="UTF-8">
<title>Football Stats API</title>
</head>
<body style="font-family: Arial, sans-serif; line-height: 1.6; background-color: #ffffff; color: #000000; padding: 20px;">
<h1>⚽ Football Stats API</h1>
<p>
Football Stats API est une application desktop développée avec Electron permettant de gérer des données liées au football :
joueurs, équipes, tournois et statistiques.
</p>
<hr>
<h2>📦 Prérequis</h2>
<p>Avant de lancer le projet, vous devez installer :</p>
<ul>
<li><strong>Node.js</strong> (version 16 ou plus recommandée)</li>
<li><strong>npm</strong> (installé automatiquement avec Node.js)</li>
<li><strong>Git</strong> (optionnel, pour cloner le projet)</li>
</ul>
<p>
👉 Télécharger Node.js :
<a href="https://nodejs.org/" target="_blank">https://nodejs.org/</a>
</p>
<hr>
<h2>🚀 Installation</h2>
<ol>
<li>Cloner le projet :
<pre><code>git clone https://github.com/ton-repo/football-stats-api.git
cd football-stats-api</code></pre>
</li>
<li>Installer les dépendances :
<pre><code>npm install</code></pre>
</li>
</ol>
<hr>
<h2>▶️ Lancement du projet</h2>
<pre><code>npm start</code></pre>
<p>
Lapplication Electron va se lancer automatiquement.
</p>
<hr>
<h2>🧠 Fonctionnalités</h2>
<h3>Joueurs</h3>
<ul>
<li>Ajouter un joueur</li>
<li>Supprimer un joueur</li>
<li>Modifier les statistiques</li>
</ul>
<h3>Équipes</h3>
<ul>
<li>Créer une équipe</li>
<li>Ajouter / retirer des joueurs</li>
<li>Supprimer une équipe</li>
</ul>
<h3>Tournois</h3>
<ul>
<li>Créer un tournoi</li>
<li>Ajouter des équipes</li>
<li>Gérer des matchs</li>
<li>Afficher les résultats</li>
</ul>
<hr>
<h2>⚙️ Architecture</h2>
<p>
Lapplication repose sur une architecture simplifiée sans serveur externe :
</p>
<ul>
<li><strong>Frontend :</strong> Electron, HTML, CSS</li>
<li><strong>Logique :</strong> JavaScript</li>
<li><strong>Stockage :</strong> localStorage</li>
</ul>
<p><strong>Fonctionnement :</strong></p>
<ol>
<li>Lutilisateur interagit avec linterface</li>
<li>Les fonctions JavaScript sont exécutées</li>
<li>Les données sont mises à jour</li>
<li>Les données sont sauvegardées dans localStorage</li>
<li>Linterface est rafraîchie automatiquement</li>
</ol>
<hr>
<h2>📁 Structure des données</h2>
<pre><code>{
"id": 0,
"name": "Nom",
"goals": 0,
"assists": 0,
"fouls": 0
}</code></pre>
<hr>
<h2>👨‍💻 Équipe</h2>
<ul>
<li><strong>Frontend :</strong> Juba</li>
<li><strong>Backend / logique :</strong> Malik</li>
</ul>
<hr>
<h2>⚠️ Remarques</h2>
<ul>
<li>Les données sont stockées en local (localStorage)</li>
<li>Aucune base de données externe nest utilisée</li>
<li>Les données restent après fermeture de lapplication</li>
</ul>
<hr>
<h2>🔮 Améliorations possibles</h2>
<ul>
<li>Ajout dune base de données (MongoDB, Firebase)</li>
<li>API backend réelle (Node.js / Express)</li>
<li>Authentification utilisateur</li>
<li>Statistiques avancées avec graphiques</li>
</ul>
</body>
</html>