Update README.md
This commit is contained in:
parent
80c35617d5
commit
8d1b17d8fc
141
README.md
141
README.md
@ -1,59 +1,53 @@
|
||||
# Football Stats API
|
||||
|
||||
## Description
|
||||
|
||||
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.
|
||||
Elle permet d'administrer des joueurs, des équipes, des tournois et de suivre leurs statistiques respectives.
|
||||
|
||||
---
|
||||
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.
|
||||
|
||||
## Technologies utilisées
|
||||
Technologies utilisées
|
||||
HTML / CSS
|
||||
|
||||
- HTML
|
||||
- CSS
|
||||
- JavaScript
|
||||
- Electron (application desktop JavaScript)
|
||||
- localStorage (stockage local navigateur)
|
||||
- JSON (format de données)
|
||||
JavaScript
|
||||
|
||||
---
|
||||
Electron (Framework pour application desktop)
|
||||
|
||||
## Architecture du projet
|
||||
localStorage (Stockage local navigateur)
|
||||
|
||||
### Frontend
|
||||
JSON (Format d'échange de données)
|
||||
|
||||
L’interface permet de :
|
||||
- afficher les joueurs
|
||||
- gérer les équipes
|
||||
- créer des tournois
|
||||
- modifier les statistiques
|
||||
Architecture du projet
|
||||
Frontend
|
||||
L’interface utilisateur permet de :
|
||||
|
||||
---
|
||||
Afficher et filtrer les joueurs.
|
||||
|
||||
### Logique (backend local)
|
||||
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 des joueurs
|
||||
- gestion des équipes
|
||||
- gestion des tournois
|
||||
- synchronisation des données
|
||||
- mise à jour dynamique de l’interface
|
||||
|
||||
---
|
||||
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 l’interface (Manipulation du DOM).
|
||||
|
||||
- ajouter un joueur
|
||||
- supprimer un joueur
|
||||
- modifier ses statistiques
|
||||
Gestion des joueurs
|
||||
Fonctionnalités
|
||||
Ajouter un joueur.
|
||||
|
||||
### Structure d’un joueur
|
||||
Supprimer un joueur.
|
||||
|
||||
```json
|
||||
Modifier les statistiques individuelles (buts, passes, fautes).
|
||||
|
||||
Structure d’un joueur
|
||||
JSON
|
||||
{
|
||||
"id": 0,
|
||||
"name": "",
|
||||
@ -63,11 +57,16 @@ La logique est entièrement gérée en JavaScript :
|
||||
}
|
||||
Gestion des équipes
|
||||
Fonctionnalités
|
||||
créer une équipe
|
||||
ajouter des joueurs
|
||||
retirer des joueurs
|
||||
supprimer une équipe
|
||||
Créer une équipe.
|
||||
|
||||
Ajouter des joueurs à une équipe.
|
||||
|
||||
Retirer des joueurs d'une équipe.
|
||||
|
||||
Supprimer une équipe.
|
||||
|
||||
Structure d’une équipe
|
||||
JSON
|
||||
{
|
||||
"id": 0,
|
||||
"name": "",
|
||||
@ -75,11 +74,16 @@ Structure d’une équipe
|
||||
}
|
||||
Gestion des tournois
|
||||
Fonctionnalités
|
||||
créer un tournoi
|
||||
ajouter des équipes
|
||||
ajouter des matchs
|
||||
afficher les résultats
|
||||
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": "",
|
||||
@ -87,6 +91,7 @@ Structure d’un tournoi
|
||||
"matches": []
|
||||
}
|
||||
Structure d’un match
|
||||
JSON
|
||||
{
|
||||
"team1": 0,
|
||||
"team2": 0,
|
||||
@ -94,33 +99,45 @@ Structure d’un match
|
||||
"score2": 0
|
||||
}
|
||||
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
|
||||
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
|
||||
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.
|
||||
Il simule un backend via JavaScript et localStorage.
|
||||
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
|
||||
Base de données réelle (MongoDB / Firebase)
|
||||
API REST avec Node.js
|
||||
Authentification utilisateur
|
||||
Statistiques avancées avec graphiques
|
||||
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.
|
||||
Loading…
x
Reference in New Issue
Block a user