From 7d7f5484854d70a038884d4402b4444f77675bc7 Mon Sep 17 00:00:00 2001 From: Bouziane Malik Date: Sat, 2 May 2026 18:20:22 +0200 Subject: [PATCH] Update README.md --- README.md | 176 ++++++++++++++++-------------------------------------- 1 file changed, 52 insertions(+), 124 deletions(-) diff --git a/README.md b/README.md index 71a9e0f..a5bde22 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,52 @@ -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 de suivre leurs statistiques respectives. +

⚽ Football Stats API

-Les données sont stockées localement grâce au localStorage, ce qui permet de conserver les informations même après la fermeture de l’application. +
+

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

+
-Technologies utilisées -HTML / CSS +
-JavaScript +
+

🛠 Technologies utilisées

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

🏗 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.
  • +
+
-JSON (Format d'échange de données) +
-Architecture du projet -Frontend -L’interface utilisateur permet de : - -Afficher et filtrer les joueurs. - -Gérer les compositions d'équipes. - -Créer et configurer des tournois. - -Modifier les statistiques en temps réel. - -Logique (Backend local) -La logique est entièrement gérée en JavaScript : - -Gestion du CRUD (Create, Read, Update, Delete) pour les entités. - -Synchronisation des données avec le stockage. - -Mise à jour dynamique de l’interface (Manipulation du DOM). - -Gestion des joueurs -Fonctionnalités -Ajouter un joueur. - -Supprimer un joueur. - -Modifier les statistiques individuelles (buts, passes, fautes). - -Structure d’un joueur -JSON +
+

👤 Structure d'un Joueur

+
 {
   "id": 0,
   "name": "",
@@ -55,89 +54,18 @@ JSON
   "assists": 0,
   "fouls": 0
 }
-Gestion des équipes
-Fonctionnalités
-Créer une équipe.
+
+
-Ajouter des joueurs à une équipe. +
-Retirer des joueurs d'une équipe. +
+

🚀 Lancement

+

npm install && npm start

+
-Supprimer une équipe. + -Structure d’une équipe -JSON -{ - "id": 0, - "name": "", - "players": [] -} -Gestion des tournois -Fonctionnalités -Créer un tournoi. - -Ajouter des équipes participantes. - -Générer et gérer des matchs. - -Afficher les résultats et classements. - -Structure d’un tournoi -JSON -{ - "id": 0, - "name": "", - "teams": [], - "matches": [] -} -Structure d’un match -JSON -{ - "team1": 0, - "team2": 0, - "score1": 0, - "score2": 0 -} -Stockage des données -Le cycle de vie des données repose sur le localStorage : - -Sérialisation : Conversion des objets JS en chaîne JSON. - -Sauvegarde : Stockage persistant dans le moteur de recherche intégré. - -Récupération : Rechargement automatique des données au lancement de l'application. - -Lancement du projet -Installation -npm install - -Lancement -npm start - -Fonctionnement global -L’utilisateur interagit avec l’interface. - -Les fonctions JavaScript sont exécutées. - -Les données sont mises à jour dans des tableaux d'objets. - -Les données sont sauvegardées dans le localStorage. - -L’interface est mise à jour automatiquement pour refléter les changements. - -Répartition du projet -Frontend : Juba - -Backend (Logique JavaScript) : Malik - -Remarque -Le projet ne repose pas sur une API serveur distante. Il simule un backend via la logique JavaScript et le stockage local. - -Améliorations possibles -Intégration d'une base de données réelle (MongoDB / Firebase). - -Développement d'une API REST avec Node.js. - -Système d'authentification utilisateur. - -Statistiques avancées avec des graphiques dynamiques. \ No newline at end of file +
\ No newline at end of file