Go to file
Benjamin Graillot d826dc9d20 [permission] Permission admin view 2019-09-18 16:40:21 +02:00
apps [permission] Permission admin view 2019-09-18 16:40:21 +02:00
locale/fr/LC_MESSAGES Move locales to project root 2019-08-14 15:15:02 +02:00
note_kfet Added permission app 2019-09-18 14:26:42 +02:00
static Merge branch 'master' into 'app_member' 2019-08-15 19:53:40 +00:00
templates minor fixes 2019-08-15 23:12:27 +02:00
.coveragerc Fix CI 2019-08-14 15:31:46 +02:00
.gitignore Move display image to Note (2) 2019-07-16 15:24:05 +02:00
.gitlab-ci.yml Regroup everything here 2019-07-08 12:55:48 +02:00
.pylintrc Regroup everything here 2019-07-08 12:55:48 +02:00
COPYING Add COPYING 2019-07-08 07:58:44 +02:00
LICENSE Added LICENSE file 2019-09-18 14:46:10 +02:00
README.md add instruction for local setup 2019-08-15 17:59:56 +02:00
manage.py and so it begins 2019-07-07 20:49:02 +00:00
nginx_note.conf and so it begins 2019-07-07 20:49:02 +00:00
requirements.txt use django_tables2 2019-08-13 18:22:19 +02:00
tox.ini Make continuous integration integrate well 2019-08-14 15:19:25 +02:00
uwsgi_note.ini and so it begins 2019-07-07 20:49:02 +00:00
uwsgi_params and so it begins 2019-07-07 20:49:02 +00:00

README.md

NoteKfet 2020

License: GPL v3 pipeline status coverage report

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 !

  1. Cloner le dépot là ou vous voulez:

     $ git@gitlab.crans.org:bde/nk20.git
    
  2. Environnement Virtuel

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

     (env)$ ./manage.py makemigrations
     (env)$ ./manage.py migrate
    
  4. Enjoy:

     (env)$ ./manage.py runserver
    

Cahier des Charges

Il est disponible ici.

Documentation

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