home done

home.md

@@ -1,4 +1,10 @@
 # GestionÉvènementiel
+
+## Table des matières
+* [Documentation utilisat-rice-eur](user-doc)
+* [Documentation développeu-se-r](dev-doc)
+* [Workflow](workflow)
+
 ## But du projet
 `GesitionÉvènementiel` est un outil dont le but est de permettre aux utilisat-rice-eur-s d'organiser un évènement, comme un projet associatif, un fesival, ect. Il permet de créer des évènements, qui contient différentes activités auxquelles les utilisateurs autorisés peuvent s'inscrire. Il permet aussi la gestion de matériel, permanent ou dédié un un seul évènement (loué, par exemple). Il permet une authentification des utilisateurs à l'aide d'un Central Authentication Service (CAS).
 
@@ -6,7 +12,22 @@ Les activités peuvent aussi bien être publiques (visibles à tous, également
 
 De manière plus pragmatique, le but est de pouvoir faciler l'organisation, à l'ENS, d'évènements tels que la Nuit, les 48h des arts, les interENS, mais aussi de plus petits évènements ou encore même de permettre aux différents bureaux (COF, BdS, etc.) de mieux gérer leur organisation (permanences, etc.).
 
-## Organisation du projet
+## Description
+### En quelle langue ?
+Le projet est principalement écrit à l'aide du framework python `Django`. Sont également utilisés les langages, libraires et technologies suivantes :
+* `html`, `css`, `js` bien entendu
+* une API REST notamment à l'aide du `django-rest-framework`
+* `backbone.js` pour interfacer le frontend avec le backend RESTful
+* des `WebSockets` notamment à l'aide de `django-channels` pour envoyer des informations en temps réel à l'utilisat-rice-eur.
+
+### Orgnisation du projet
 Le projet est découpé en plusieurs applications, chacune dédiée à des choses différentes. Les évènements sont gérés dans l'application `event`, le matériel dans l'application `equipment`. Dans l'application `shared` se trouvent tous les éléments utilisés partout dans le projet, commes les templates de base (`base.html`, etc.), les fichiers statiques communs (css commun, librairies js, etc.) et autres choses inhérentes au projet. L'application `communication` est dédiée à la gestion des commentaires et des notifications.
 
-Enfin dans l'application `api` se trouvent les différents points d'entrées pour l'API. Cette application est découpée en différents répertoire, qui correspondent aux autres applications servies par l'API.
+Enfin dans l'application `api` se trouvent les différents points d'entrées pour l'API. Cette application est découpée en différents répertoire, qui correspondent aux autres applications servies par l'API.
+
+Plus de détails concernant le workflow peuvent se trouver sur la page dédiée.
+
+## le Wiki du projet
+Le wiki du projet c'est ici. C'est un repo `git`. Il peut-être bon de le tenir à jour lorsqu'on ajoute du contenu sur le répertoire principal, notamment après validation d'une merge request. Il s'agit de maintenir autant la documentation destinée au/à la développeu-se-r qu'à l'utilisat-ric-eur.
+
+

user-doc.md

@@ -0,0 +1 @@
+# Documentation utilisat-rice-eur-s