From c01fe3c3f48538b9592da775a0070207e684eabe Mon Sep 17 00:00:00 2001 From: Bouziane Malik Date: Sun, 3 May 2026 22:33:49 +0200 Subject: [PATCH] Update README.md --- README.md | 179 ++++++++++++++++++++++++++++++++++++++---------------- 1 file changed, 128 insertions(+), 51 deletions(-) diff --git a/README.md b/README.md index a5bde22..89ac87f 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,148 @@ -
+ + + + + Football Stats API + + -

⚽ Football Stats API

+

⚽ Football Stats API

-
-

📝 Description

-

- 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. -

-

- Les données sont stockées localement via localStorage, garantissant la persistance même après fermeture de l’application. -

-
+

+ 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. +

-
-

🛠 Technologies utilisées

-
    -
  • HTML / CSS
    • -
  • JavaScript
    • -
  • Electron (Desktop)
    • -
  • localStorage (Stockage local)
    • -
  • JSON (Format de données)
    • -
-
+

📦 Prérequis

+

Avant de lancer le projet, vous devez installer :

+ + +

+ 👉 Télécharger Node.js : + https://nodejs.org/ +

-
-

🏗 Architecture

-

🖥️ Frontend (Juba)

-
    -
  • Affichage et gestion de l'interface utilisateur.
    • -
  • Formulaires de saisie pour les joueurs et matchs.
    • -
-

⚙️ Backend Local (Malik)

-
    -
  • Logique de calcul des statistiques.
    • -
  • Gestion du CRUD et synchronisation JSON.
    • -
-
+

🚀 Installation

+ +
    +
  1. Cloner le projet : + 
    git clone https://github.com/ton-repo/football-stats-api.git
+cd football-stats-api
    +
    2. + +
  2. Installer les dépendances : + 
    npm install
    +
    3. +
-
-

👤 Structure d'un Joueur

-
-{
+  
▶️ Lancement du projet

+
+  
npm start

+
+  

+    L’application Electron va se lancer automatiquement.
+  

+
+  

+
+  
🧠 Fonctionnalités

+
+  
Joueurs

+  
    
+    
  • Ajouter un joueur
    • 
+    
  • Supprimer un joueur
    • 
+    
  • Modifier les statistiques
    • 
+  

+
+  
Équipes

+  
    
+    
  • Créer une équipe
    • 
+    
  • Ajouter / retirer des joueurs
    • 
+    
  • Supprimer une équipe
    • 
+  

+
+  
Tournois

+  
    
+    
  • Créer un tournoi
    • 
+    
  • Ajouter des équipes
    • 
+    
  • Gérer des matchs
    • 
+    
  • Afficher les résultats
    • 
+  

+
+  

+
+  
⚙️ Architecture

+
+  

+    L’application repose sur une architecture simplifiée sans serveur externe :
+  

+
+  
    
+    
  • Frontend : Electron, HTML, CSS
    • 
+    
  • Logique : JavaScript
    • 
+    
  • Stockage : localStorage
    • 
+  

+
+  
Fonctionnement :

+  
    
+    
  1. L’utilisateur interagit avec l’interface
    2. 
+    
  2. Les fonctions JavaScript sont exécutées
    3. 
+    
  3. Les données sont mises à jour
    4. 
+    
  4. Les données sont sauvegardées dans localStorage
    5. 
+    
  5. L’interface est rafraîchie automatiquement
    6. 
+  

+
+  

+
+  
📁 Structure des données

+
+  
{
   "id": 0,
-  "name": "",
+  "name": "Nom",
   "goals": 0,
   "assists": 0,
   "fouls": 0
-}
-

-
+}
-
-

🚀 Lancement

-

npm install && npm start

-
+

👨‍💻 Équipe

-
-

Note : Ce projet simule un backend via JavaScript et localStorage.

-
+ -
\ No newline at end of file +
+ +

⚠️ Remarques

+ + + +
+ +

🔮 Améliorations possibles

+ + + + + \ No newline at end of file