Update README.md

This commit is contained in:
Bouziane Malik 2026-05-02 18:19:25 +02:00
parent 80c35617d5
commit 8d1b17d8fc

139
README.md
View File

@ -1,59 +1,53 @@
# 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.
## Description Elle permet d'administrer des joueurs, des équipes, des tournois et de suivre leurs statistiques respectives.
Football Stats API est une application desktop développée avec Electron permettant de gérer des données liées au football. 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 lapplication.
Elle permet de gérer des joueurs, des équipes, des tournois et leurs statistiques.
Les données sont stockées localement grâce au localStorage, ce qui permet de conserver les informations même après fermeture de lapplication. Technologies utilisées
HTML / CSS
--- JavaScript
## Technologies utilisées Electron (Framework pour application desktop)
- HTML localStorage (Stockage local navigateur)
- CSS
- JavaScript
- Electron (application desktop JavaScript)
- localStorage (stockage local navigateur)
- JSON (format de données)
--- JSON (Format d'échange de données)
## Architecture du projet Architecture du projet
Frontend
Linterface utilisateur permet de :
### Frontend Afficher et filtrer les joueurs.
Linterface permet de : Gérer les compositions d'équipes.
- afficher les joueurs
- gérer les équipes
- créer des tournois
- modifier les statistiques
--- Créer et configurer des tournois.
### Logique (backend local) Modifier les statistiques en temps réel.
Logique (Backend local)
La logique est entièrement gérée en JavaScript : La logique est entièrement gérée en JavaScript :
- gestion des joueurs
- gestion des équipes
- gestion des tournois
- synchronisation des données
- mise à jour dynamique de linterface
--- Gestion du CRUD (Create, Read, Update, Delete) pour les entités.
## Gestion des joueurs Synchronisation des données avec le stockage.
### Fonctionnalités Mise à jour dynamique de linterface (Manipulation du DOM).
- ajouter un joueur Gestion des joueurs
- supprimer un joueur Fonctionnalités
- modifier ses statistiques Ajouter un joueur.
### Structure dun joueur Supprimer un joueur.
```json Modifier les statistiques individuelles (buts, passes, fautes).
Structure dun joueur
JSON
{ {
"id": 0, "id": 0,
"name": "", "name": "",
@ -63,11 +57,16 @@ La logique est entièrement gérée en JavaScript :
} }
Gestion des équipes Gestion des équipes
Fonctionnalités Fonctionnalités
créer une équipe Créer une équipe.
ajouter des joueurs
retirer des joueurs Ajouter des joueurs à une équipe.
supprimer une équipe
Retirer des joueurs d'une équipe.
Supprimer une équipe.
Structure dune équipe Structure dune équipe
JSON
{ {
"id": 0, "id": 0,
"name": "", "name": "",
@ -75,11 +74,16 @@ Structure dune équipe
} }
Gestion des tournois Gestion des tournois
Fonctionnalités Fonctionnalités
créer un tournoi Créer un tournoi.
ajouter des équipes
ajouter des matchs Ajouter des équipes participantes.
afficher les résultats
Générer et gérer des matchs.
Afficher les résultats et classements.
Structure dun tournoi Structure dun tournoi
JSON
{ {
"id": 0, "id": 0,
"name": "", "name": "",
@ -87,6 +91,7 @@ Structure dun tournoi
"matches": [] "matches": []
} }
Structure dun match Structure dun match
JSON
{ {
"team1": 0, "team1": 0,
"team2": 0, "team2": 0,
@ -94,33 +99,45 @@ Structure dun match
"score2": 0 "score2": 0
} }
Stockage des données Stockage des données
Le cycle de vie des données repose sur le localStorage :
Les données sont stockées via 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.
conversion en JSON
sauvegarde dans le navigateur
rechargement automatique au lancement
Lancement du projet Lancement du projet
Installation Installation
npm install npm install
Lancement Lancement
npm start npm start
Fonctionnement global Fonctionnement global
Lutilisateur interagit avec linterface Lutilisateur interagit avec linterface.
Les fonctions JavaScript sont exécutées
Les données sont mises à jour dans des tableaux Les fonctions JavaScript sont exécutées.
Les données sont sauvegardées dans localStorage
Linterface est mise à jour automatiquement Les données sont mises à jour dans des tableaux d'objets.
Les données sont sauvegardées dans le localStorage.
Linterface est mise à jour automatiquement pour refléter les changements.
Répartition du projet Répartition du projet
Frontend : Juba Frontend : Juba
Backend (logique JavaScript) : Malik
Remarque
Le projet ne repose pas sur une API serveur. Backend (Logique JavaScript) : Malik
Il simule un backend via JavaScript et localStorage.
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 Améliorations possibles
Base de données réelle (MongoDB / Firebase) Intégration d'une base de données réelle (MongoDB / Firebase).
API REST avec Node.js
Authentification utilisateur Développement d'une API REST avec Node.js.
Statistiques avancées avec graphiques
Système d'authentification utilisateur.
Statistiques avancées avec des graphiques dynamiques.