# Pool It Yourself (PIY)
## Installation
Demande virtualenv ainsi que python 3
Pour installer le projet (sur un unixoïde)
git clone git@gitlab.inria.fr:piy/piy.git
cd piy
virtualenv .
source ./bin/activate
pip install -r requirement.txt
Organisation du projet
Le projet django se trouve dans le dossier piy
.
Ce dossier contient un fichier manage.py
permettant d'effectuer des actions
sur le projet (migration de la base de donnée, lancer un serveur local, ...).
Le dossier piy
contient des fichiers de configurations globaux du projet (a ne pas toucher donc).
Le dossier piy_api
contient le code relatif à l'API.
Dans ce dossier le dossier migrations
contient les changements dans la base de donnée (a ne pas toucher).
Le fichier models
contient le modèle de la base de donnée.
Le fichier urls.py
contient les routes vers les vues.
Le fichier views.py
contient les vues elles mêmes.
Les urls (paths) relatifs à l'API seront sous l'url /api/
.
Lancer un serveur de test local
(dans piy)
./manage.py migrate (en cas de modification du modèle)
./manage.py runserver
Effectuer une modification du modèle
(modification du modèle)
./manage.py makemigrations
(commit de la modification)
## Effectuer une modification sur le code
git pull
git checkout -b nom_de_la_branche
...
modification
...
git commit -m "le message du commit"
git push --set-origin origin nom_de_la_branche
...
modification
...
git commit -m "message"
git push
Pour valider une modification dans master effectuer une merge request sur gitlab.