Update README.md
This commit is contained in:
parent
7d7f548485
commit
c01fe3c3f4
171
README.md
171
README.md
@ -1,71 +1,148 @@
|
|||||||
<div style="font-family: sans-serif; line-height: 1.6; color: #333; max-width: 800px; margin: auto;">
|
<!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 style="color: #2c3e50; border-bottom: 2px solid #2c3e50; padding-bottom: 10px;">⚽ Football Stats API</h1>
|
<h1>⚽ Football Stats API</h1>
|
||||||
|
|
||||||
<section>
|
|
||||||
<h2 style="color: #2980b9;">📝 Description</h2>
|
|
||||||
<p>
|
<p>
|
||||||
<strong>Football Stats API</strong> est une application desktop développée avec <strong>Electron</strong> permettant de gérer des données liées au football.
|
Football Stats API est une application desktop développée avec Electron permettant de gérer des données liées au football :
|
||||||
Elle permet d'administrer des joueurs, des équipes, des tournois et leurs statistiques.
|
joueurs, équipes, tournois et statistiques.
|
||||||
</p>
|
</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>
|
<p>
|
||||||
Les données sont stockées localement via <code>localStorage</code>, garantissant la persistance même après fermeture de l’application.
|
👉 Télécharger Node.js :
|
||||||
|
<a href="https://nodejs.org/" target="_blank">https://nodejs.org/</a>
|
||||||
</p>
|
</p>
|
||||||
</section>
|
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
<section>
|
<h2>🚀 Installation</h2>
|
||||||
<h2 style="color: #2980b9;">🛠 Technologies utilisées</h2>
|
|
||||||
<ul>
|
<ol>
|
||||||
<li>HTML / CSS</li>
|
<li>Cloner le projet :
|
||||||
<li>JavaScript</li>
|
<pre><code>git clone https://github.com/ton-repo/football-stats-api.git
|
||||||
<li>Electron (Desktop)</li>
|
cd football-stats-api</code></pre>
|
||||||
<li>localStorage (Stockage local)</li>
|
</li>
|
||||||
<li>JSON (Format de données)</li>
|
|
||||||
</ul>
|
<li>Installer les dépendances :
|
||||||
</section>
|
<pre><code>npm install</code></pre>
|
||||||
|
</li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
<section>
|
<h2>▶️ Lancement du projet</h2>
|
||||||
<h2 style="color: #2980b9;">🏗 Architecture</h2>
|
|
||||||
<h3>🖥️ Frontend (Juba)</h3>
|
<pre><code>npm start</code></pre>
|
||||||
<ul>
|
|
||||||
<li>Affichage et gestion de l'interface utilisateur.</li>
|
<p>
|
||||||
<li>Formulaires de saisie pour les joueurs et matchs.</li>
|
L’application Electron va se lancer automatiquement.
|
||||||
</ul>
|
</p>
|
||||||
<h3>⚙️ Backend Local (Malik)</h3>
|
|
||||||
<ul>
|
|
||||||
<li>Logique de calcul des statistiques.</li>
|
|
||||||
<li>Gestion du CRUD et synchronisation JSON.</li>
|
|
||||||
</ul>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
<section>
|
<h2>🧠 Fonctionnalités</h2>
|
||||||
<h2 style="color: #2980b9;">👤 Structure d'un Joueur</h2>
|
|
||||||
<pre style="background: #f4f4f4; padding: 10px; border-radius: 5px;">
|
<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>
|
||||||
|
L’application 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>L’utilisateur interagit avec l’interface</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>L’interface est rafraîchie automatiquement</li>
|
||||||
|
</ol>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2>📁 Structure des données</h2>
|
||||||
|
|
||||||
|
<pre><code>{
|
||||||
"id": 0,
|
"id": 0,
|
||||||
"name": "",
|
"name": "Nom",
|
||||||
"goals": 0,
|
"goals": 0,
|
||||||
"assists": 0,
|
"assists": 0,
|
||||||
"fouls": 0
|
"fouls": 0
|
||||||
}
|
}</code></pre>
|
||||||
</pre>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
<section>
|
<h2>👨💻 Équipe</h2>
|
||||||
<h2 style="color: #2980b9;">🚀 Lancement</h2>
|
|
||||||
<p><code>npm install</code> && <code>npm start</code></p>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<footer style="margin-top: 20px; font-size: 0.9em; color: #7f8c8d;">
|
<ul>
|
||||||
<p><em>Note : Ce projet simule un backend via JavaScript et localStorage.</em></p>
|
<li><strong>Frontend :</strong> Juba</li>
|
||||||
</footer>
|
<li><strong>Backend / logique :</strong> Malik</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
</div>
|
<hr>
|
||||||
|
|
||||||
|
<h2>⚠️ Remarques</h2>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>Les données sont stockées en local (localStorage)</li>
|
||||||
|
<li>Aucune base de données externe n’est utilisée</li>
|
||||||
|
<li>Les données restent après fermeture de l’application</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<hr>
|
||||||
|
|
||||||
|
<h2>🔮 Améliorations possibles</h2>
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<li>Ajout d’une 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>
|
||||||
Loading…
x
Reference in New Issue
Block a user
