README.md 1.92 KB
Newer Older
Pierre-antoine Comby's avatar
Pierre-antoine Comby committed
1
# NoteKfet 2020
erdnaxe's avatar
erdnaxe committed
2 3 4 5 6

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0.txt)
[![pipeline status](https://gitlab.crans.org/bde/nk20/badges/master/pipeline.svg)](https://gitlab.crans.org/bde/nk20/nk20/commits/master)
[![coverage report](https://gitlab.crans.org/bde/nk20/badges/master/coverage.svg)](https://gitlab.crans.org/bde/nk20/commits/master)

Pierre-antoine Comby's avatar
Pierre-antoine Comby committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
## Installation sur un serveur

On supposera pour la suite que vous utiliser debian/ubuntu sur un serveur tout nu ou bien configuré.

1. Paquets nécessaires

    $ sudo apt install nginx python3 python3-pip python3-dev uwsgi
    $ sudo apt install uwsgi-plugin-python3 python3-virtualenv git

2. Clonage du dépot

    on se met au bon endroit :

        $ cd /var/www/
        $ mkdir note_kfet
        $ cd note_kfet
        $ git clone git@gitlab.crans.org:bde/nk20.git .
3. Environment Virtuel
   
   À la racine du projet:

        $ virtualenv env
        $ source /env/bin/activate
        (env)$ pip install -r requirements.txt
        (env)$ deactivate

4. uwsgi  et Nginx

    On utilise uwsgi et Nginx pour gérer le coté serveu :

        $ sudo ln -s /var/www/note_kfet/nginx_note.conf /etc/nginx/sites-enabled/
        
   **Modifier la config nginx  pour l'adapter à votre server!**
   
   Si l'on a un emperor (plusieurs instance uwsgi):
    
        $ sudo ln -s /var/www/note_kfet/uwsgi_note.ini /etc/uwsgi/sites/

    Sinon: 
        
        $ sudo ln -s /var/www/note_kfet/uwsgi_note.ini /etc/uwsgi/apps-enabled/
5. Base de données

    Pour le moment c'est du sqllite, pas de config particulière.
    
## Développer en local

Il est tout a fait possible de travailler en local, vive `./manage.py runserver` !

## Cahier des Charges 

Pierre-antoine Comby's avatar
Pierre-antoine Comby committed
58
Il est disponible [ici](https://wiki.crans.org/NoteKfet/NoteKfet2018/CdC). 
Pierre-antoine Comby's avatar
Pierre-antoine Comby committed
59 60 61 62

## Documentation

La documentation est générée par django et son module admindocs. **Commenter votre code !*