mpepin created page: user doc/bda

user-doc/bda.md

@@ -0,0 +1,72 @@
+Le BdA
+======
+
+L'application `bda` gère les spectacles du BdA avec un système d'inscriptions et de tirages au sort.
+
+Organisation de la base de données
+------------------------------------------------
+
+Les modèles utilisés par l'application (et accessibles depuis l'[interface admin](gestiocof admin), sont les suivants : 
+
+- Un `tirage` réunit les informations relatives à un tirage au sort (date, etc.).
+- Une `salle` réunit quelques informations sur les salles de spectacles.
+- Les `spectacle`s sont attachés à un tirage au sort et une salle de spectacle.
+- Un `participant` est une entité attachée à un utilisateur de gestioCOF et un tirage. C'est un utilisateur
+  qui s'est inscrit à un tirage donné.
+- Les participants peuvent avoir des `vœux`, un vœux est une entité liée à un participant et un spectacle, elle
+  matérialise la volonté d'un utilisateur d'obtenir un ou deux places à un spectacle donné.
+- Après le tirage au sort, les participants ont des `attribution`s. Elles lient aussi un participant à un spectacle 
+  mais cette fois pour signifier qu'un utilisateur dispose d'une place.
+
+Pour plus de détails sur les attributs de chaque modèle, visiter l'[interface admin](gestiocof admin).
+
+Outils des membres
+--------------------------
+
+Les membres du COF peuvent effectuer un certain nombre d'opérations pour chaque tirage.
+les fonctionnalités décrites ci-dessus sont accessibles à travers les liens de la page d'accueil.
+
+### inscription
+
+Après l'ouverture et avant la clôture d'un tirage, on peut s'y inscrire, i.e. faire une liste de vœux.
+Il faut alors remplir le formulaire qui s'affiche. Les choix sont ordonnés et on a
+la possibilité de demander une / deux si possible / uniquement deux places pour chaque spectacle.
+
+### Ratio des demandes
+
+Affiche pour chaque spectacle le nombre de demandes et le nombre de places disponibles.
+
+### Mes places
+
+Après un tirage, indique les places que l'on s'est vu attribuer.
+
+### Revente
+
+Après un tirage permet d'envoyer un mail à bda-revente pour revendre ses places.
+
+
+Outils du burô
+-------------------
+
+Les utilisateurs privilégiés peuvent créer des tirages, spectacles et salles via l'interface admin. Il est aussi
+possible de toucher aux attributions et aux vœux mais ça devrait rester exceptionnel.
+
+### Nouvelle saison
+
+Pour commencer une nouvelle saison, il faut donc d'abord créer un tirage puis ajouter les spectacles. Les salle 
+étant indépendantes des tirages, elles peuvent être ajoutées ou modifiées à tout moment. La propriété `actif`
+des tirages indique s'ils concernent l'année en cours ou au contraire si ce sont des archives. Si un tirage est actif et 
+si la date d'ouverture est passée, il apparaîtra sur la page d'accueil.
+
+### Lancer un tirage
+
+Une fois tous les spectacles entrés et la date du tirage passée (faut laisser tout le monde s'inscrire \^\^), on peut lancer
+le tirage en entrant l'url `/bda/tirage/<id>` où `<id>` est l'identifiant du tirage à lancer. En l'état actuel des chose, 
+le tirage ne sera pas effectif sans changer un booléen dans le code, c'est une sécurité provisoire.
+
+### Liens utiles du BdA
+
+La rubrique "liens utiles du BdA" permet d'afficher un certains nombre d'infos :
+- Les abonnés aux deux mailing-list du BdA.
+- Les participants à chaque spectacle.
+- Un calendrier .ics des spectacles.