ajout readme
This commit is contained in:
parent
7a6760847d
commit
80c35617d5
126
README.md
Normal file
126
README.md
Normal file
@ -0,0 +1,126 @@
|
||||
# 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 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 l’application.
|
||||
|
||||
---
|
||||
|
||||
## Technologies utilisées
|
||||
|
||||
- HTML
|
||||
- CSS
|
||||
- JavaScript
|
||||
- Electron (application desktop JavaScript)
|
||||
- localStorage (stockage local navigateur)
|
||||
- JSON (format de données)
|
||||
|
||||
---
|
||||
|
||||
## Architecture du projet
|
||||
|
||||
### Frontend
|
||||
|
||||
L’interface permet de :
|
||||
- afficher les joueurs
|
||||
- gérer les équipes
|
||||
- créer des tournois
|
||||
- modifier les statistiques
|
||||
|
||||
---
|
||||
|
||||
### Logique (backend local)
|
||||
|
||||
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 l’interface
|
||||
|
||||
---
|
||||
|
||||
## Gestion des joueurs
|
||||
|
||||
### Fonctionnalités
|
||||
|
||||
- ajouter un joueur
|
||||
- supprimer un joueur
|
||||
- modifier ses statistiques
|
||||
|
||||
### Structure d’un joueur
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 0,
|
||||
"name": "",
|
||||
"goals": 0,
|
||||
"assists": 0,
|
||||
"fouls": 0
|
||||
}
|
||||
Gestion des équipes
|
||||
Fonctionnalités
|
||||
créer une équipe
|
||||
ajouter des joueurs
|
||||
retirer des joueurs
|
||||
supprimer une équipe
|
||||
Structure d’une équipe
|
||||
{
|
||||
"id": 0,
|
||||
"name": "",
|
||||
"players": []
|
||||
}
|
||||
Gestion des tournois
|
||||
Fonctionnalités
|
||||
créer un tournoi
|
||||
ajouter des équipes
|
||||
ajouter des matchs
|
||||
afficher les résultats
|
||||
Structure d’un tournoi
|
||||
{
|
||||
"id": 0,
|
||||
"name": "",
|
||||
"teams": [],
|
||||
"matches": []
|
||||
}
|
||||
Structure d’un match
|
||||
{
|
||||
"team1": 0,
|
||||
"team2": 0,
|
||||
"score1": 0,
|
||||
"score2": 0
|
||||
}
|
||||
Stockage des données
|
||||
|
||||
Les données sont stockées via localStorage :
|
||||
|
||||
conversion en JSON
|
||||
sauvegarde dans le navigateur
|
||||
rechargement automatique au lancement
|
||||
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
|
||||
Les données sont sauvegardées dans localStorage
|
||||
L’interface est mise à jour automatiquement
|
||||
Répartition du projet
|
||||
Frontend : Juba
|
||||
Backend (logique JavaScript) : Malik
|
||||
Remarque
|
||||
|
||||
Le projet ne repose pas sur une API serveur.
|
||||
Il simule un backend via JavaScript et localStorage.
|
||||
|
||||
Améliorations possibles
|
||||
Base de données réelle (MongoDB / Firebase)
|
||||
API REST avec Node.js
|
||||
Authentification utilisateur
|
||||
Statistiques avancées avec graphiques
|
||||
Loading…
x
Reference in New Issue
Block a user