nk20/README.md

NoteKfet 2020

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.

Installer 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 clone git@gitlab.crans.org:bde/nk20.git
   

2. Initialiser l'environnement Virtuel

    $ cd nk20
    $ 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
   

Minimal Setup

1. Créer un superuser :

    (env)$ ./manage.py createsuperuser
   

Avec ce dernier vous pouvez vous connecter à l'interface admin de Django, avoir accès à la doc auto-générée du projet, jouer avec des models, etc ...

Cahier des Charges

Il est disponible ici.

Documentation

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