Ce dossier docs/ regroupe l’ensemble des documents de conception, organisation et développement du projet numérique du club de volley de Saint Barthélemy d’Anjou.
L’objectif de cette documentation est double :
- Fournir une vision claire et structurée du projet pour tous les contributeurs
- Servir de référence technique tout au long du développement et de la maintenance
Ce README agit comme un sommaire détaillé, expliquant le rôle de chaque document et la manière dont ils s’enchaînent dans le cycle de développement.
- Type de projet : Site web + back-office
- Architecture : MERN (MongoDB, Express, React, Node.js)
- Public cible : visiteurs, adhérents, bénévoles, administrateurs du club
- Objectif principal : structurer et professionnaliser la présence numérique du club
docs/
├── workflow/
├── cahier-des-charges/
├── uml/
├── cartographies/
├── maquettes/
├── data-conception/
└── README.md
Chaque dossier correspond à une étape clé du cycle projet, de l’idée au code.
- Résumé du workflow Git (branches, commits, releases)
- Règles de nommage (branches, commits, versions)
- Processus CI/CD (GitHub Actions)
- Fonctionnement de pre-commit (linters, formatters)
- Garantir une qualité de code constante
- Uniformiser les pratiques entre développeurs
- Sécuriser les merges vers
main
- Contexte du club
- Objectifs fonctionnels et stratégiques
- Périmètre du projet
- Contraintes (budget, RGPD, technique)
- Planning prévisionnel
- Critères de validation
- Servir de référence fonctionnelle
- Justifier les choix techniques
- Éviter les dérives fonctionnelles (scope creep)
- Décrire le comportement de l’application
- Clarifier les interactions :
- utilisateur ↔ front
- front ↔ API
- API ↔ base de données
- Visualiser l’architecture globale
- Identifier les dépendances
- Anticiper les points critiques (scraping, APIs externes)
- Wireframes
- Maquettes desktop & mobile
- Parcours utilisateur
- Pages publiques
- Interfaces back-office
- Aligner design, UX et développement
- Réduire les allers-retours front-end
- Garantir la cohérence avec la charte graphique
- Dictionnaire de données
- MCD (Modèle Conceptuel de Données)
- MLD (Modèle Logique de Données)
- MPD (Modèle Physique – MongoDB)
- Règles de gestion des données
- Structurer la base MongoDB
- Garantir la cohérence des schémas
- Faciliter l’écriture des modèles Mongoose
- Préparer l’historisation (saisons, archives)
- Installation et configuration de Node.js et Express
- Structure du projet backend (server.js, src/app.js, routes, controllers, models, middlewares)
- Connexion à MongoDB avec Mongoose et configuration des variables d’environnement via .env
- Création d’une API REST CRUD pour les articles (GET, POST, PUT, DELETE)
- Exemple de modèle Mongoose (Article) et contrôleur associé
- Mise en place d’un serveur Express fonctionnel avec test via navigateur ou Postman
- Fournir une API backend pour le site du club de volley, capable de gérer les contenus dynamiques (articles, pages, partenaires, équipes, galerie…)
- Assurer une architecture claire et maintenable pour ajouter facilement de nouvelles fonctionnalités
- Préparer la connexion avec le frontend React et permettre un back-office sécurisé pour les administrateurs
- Utiliser MongoDB de manière flexible, avec création automatique des bases et collections à l’insertion de documents
- Permettre le développement rapide grâce à nodemon et à une configuration simple des routes et contrôleurs