|
|
@@ -0,0 +1,39 @@
|
|
|
+# Secret santa
|
|
|
+Secret santa est une coutume de noël lors de laquelle un groupe de personnes s'offre des cadeaux.
|
|
|
+Chaques personne va devoir offrir un cadeau à une autre personne tirée au sort. Ainsi, chaque personne donne et reçoit un cadeau.
|
|
|
+_Note: Le tirage au sort peut avoir lieu avant, comne après la recherche de cadeaux._
|
|
|
+Ce service permet de créer facilement un tirage au sort pour des personnes éloignées géographiquement.
|
|
|
+
|
|
|
+## Installation
|
|
|
+L'installation sur serveur privé de SecretSanta est tràs facile :
|
|
|
+- Mettre les fichiers sur un serveur
|
|
|
+- Mettre en place une base de donnée MySQL avec le fichier install.sql
|
|
|
+- Modifier le ficher src/config pour renseigner vos informations.
|
|
|
+- Il est recommendé de remplacer les deux SALT présentes dans le même fichier (Ils permettent de generer des addresse pour vos tirages)
|
|
|
+
|
|
|
+## Utilisation
|
|
|
+
|
|
|
+### Création du tirage au sort
|
|
|
+Vous pouvez choisir un nom et une description pour votre tirage (Exemple de nom : Noël 2016.
|
|
|
+La description peut contenir des règles supplementaires (Exemple : budget max), la date de rendez-vous ou d'autres informations utiles.
|
|
|
+Vous recevrez immédiatement un mail récapitulatif, et vous arriverez sur la page d'administration de votre tirage.
|
|
|
+
|
|
|
+### Page d'inscription au tirage
|
|
|
+La page publique de gestion permet aux utilisateurs de s'inscrire, et de gérer les contraintes.
|
|
|
+Pour ajouter une nouvel utilisateur, vous devez renseigner au moins votre adresse e-mail, puis cliquer sur `valider`.
|
|
|
+_Votre e-mail ne sera visible que par la personne qui vous offrira votre cadeau._
|
|
|
+Les cases à cocher sur la partie droite permettent de gérer les contraintes.
|
|
|
+Par exemple, si un utilisateur Alice ne veut / ne peut pas offrir de cadeau à Bob, il suffit de l'indiquer en décochant la case
|
|
|
+à l'intersection de Bob et Alice.
|
|
|
+
|
|
|
+### Administration de votre tirage
|
|
|
+Sur cette page, vous allez pouvoir administrer votre Secret Santa.
|
|
|
+Cet espace réservé contient des informations communes avec la page d'inscription.
|
|
|
+
|
|
|
+Le bloc de lien public contient le lien à transmettre aux participants qui souhaiteraient s'inscrire
|
|
|
+(Ce lien est aussi présent dans l'e-mail récapitulatif qui vous aurez reçu en début de campagne).
|
|
|
+
|
|
|
+Le dernier bloc, contenant le bouton `Valider et envoyer les e-mails` permet de valider la fin des inscriptions.
|
|
|
+Des emails seront envoyés à tous les participants leur indiquant à qui ils doivent offrir leur cadeau.
|
|
|
+
|
|
|
+Une fois terminé, un bloc `Résultats du tirage` apparaît. Les résultats sont masqués par défaut.
|
isundil