Une application de gestion complète pour association de cirque
Le Circographe est une application de gestion complète pour une association de cirque, développée avec Ruby on Rails 8.0.1. Cette documentation couvre l'ensemble des aspects techniques, fonctionnels et organisationnels du projet.
- 📘 Guide de démarrage rapide
- 🏛️ Structure de la documentation
- 🔄 Domaines métier
- 📋 Guides par cas d'usage
- 📝 Contribution
- 📞 Support
- 🛠️ Guide de développement
| Documentation | Description |
|---|---|
| 🔧 Installation | Comment installer l'application |
| 🚀 Premier pas | Guide de prise en main rapide |
| ❓ FAQ | Questions fréquemment posées |
Notre documentation est organisée de manière hiérarchique pour faciliter la navigation:
- 📁 Domaines Métier - Règles et spécifications métier par domaine
- 📁 Documentation Whimsical - Contient toute les documentations et graphiques
- 📁 Wireframe - Wireframe
- 📁 Schema bdd - Schema BDD
- 📁 User Stories - User Stories
- 📁 Guides Utilisateur - Guides pour les utilisateurs finaux
Notre application est organisée autour de six domaines métier clairement définis, chacun avec ses propres responsabilités:
| Domaine | Description | Documentation |
|---|---|---|
| Adhésion |
Gestion des adhésions Basic et Cirque, incluant:
|
Spécifications Règles métier |
| Cotisation |
Formules d'accès aux entraînements:
|
Spécifications Règles métier |
| Paiement |
Transactions financières:
|
Spécifications Règles métier |
| Présence |
Suivi des entraînements:
|
Spécifications Règles métier |
| Rôles |
Gestion des accès:
|
Spécifications Règles métier |
| Notification |
Communication automatisée:
|
Spécifications Règles métier |
Pour faciliter la navigation, nous proposons des guides par cas d'usage qui traversent les différents domaines:
Voir les guides et références
- Guide complet
- Domaines associés:
Voir les guides et références
- Guide complet
- Domaines associés:
Voir les guides et références
- Guide complet
- Domaines associés:
Nous accueillons avec plaisir les contributions de la communauté !
Guide de contribution
Pour contribuer au projet, veuillez consulter notre guide de contribution détaillé qui explique:
- Le workflow Git à suivre
- Les conventions de nommage des branches
- Les conventions de commit
- Le processus de revue de code
- Les standards de test
Standards de documentation
- Utiliser le Markdown pour tous les documents
- Suivre les templates fournis
- Maintenir les liens entre documents
- Mettre à jour le glossaire si nécessaire
- v0.2 - Before refacto products + Users + Opening Hours
- v0.5.1 - Refactorisation design/UX + Features
- v0.5.2 - Hotfix for opening hours display
- Email : tech@lecirco.org
- Discord : #tech-support
- Email : business@lecirco.org
- Discord : #business-support
⬅️ Retour au projet | ⬆️ Haut de page
Ce projet est sous licence MIT - voir le fichier LICENSE.md pour plus de détails.