nk20/README.md

93 lines
2.5 KiB
Markdown
Raw Normal View History

2019-07-07 21:31:20 +00:00
# NoteKfet 2020
2019-07-08 10:59:27 +00:00
[![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)
2019-07-07 21:31:20 +00:00
## 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
2020-01-21 21:03:59 +00:00
$ sudo apt install nginx python3 python3-pip python3-dev uwsgi
$ sudo apt install uwsgi-plugin-python3 python3-virtualenv git
2019-07-07 21:31:20 +00:00
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
2019-08-15 15:59:56 +00:00
2019-07-07 21:31:20 +00:00
À 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/
2019-08-15 15:59:56 +00:00
2019-07-07 21:31:20 +00:00
**Modifier la config nginx pour l'adapter à votre server!**
2019-08-15 15:59:56 +00:00
2019-07-07 21:31:20 +00:00
Si l'on a un emperor (plusieurs instance uwsgi):
2019-08-15 15:59:56 +00:00
2019-07-07 21:31:20 +00:00
$ sudo ln -s /var/www/note_kfet/uwsgi_note.ini /etc/uwsgi/sites/
2019-08-15 15:59:56 +00:00
Sinon:
2019-07-07 21:31:20 +00:00
$ sudo ln -s /var/www/note_kfet/uwsgi_note.ini /etc/uwsgi/apps-enabled/
2019-08-15 15:59:56 +00:00
2019-07-07 21:31:20 +00:00
5. Base de données
Pour le moment c'est du sqllite, pas de config particulière.
2019-08-15 15:59:56 +00:00
2020-01-21 21:03:59 +00:00
## Installer en local
2019-07-07 21:31:20 +00:00
Il est tout a fait possible de travailler en local, vive `./manage.py runserver` !
2019-08-15 15:59:56 +00:00
1. Cloner le dépot là ou vous voulez:
2020-01-21 21:03:59 +00:00
$ git clone git@gitlab.crans.org:bde/nk20.git
2019-08-15 15:59:56 +00:00
2020-01-21 21:03:59 +00:00
2. Initialiser l'environnement Virtuel
$ cd nk20
2019-08-15 15:59:56 +00:00
$ 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
2020-01-21 21:03:59 +00:00
## 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 ...
2019-08-15 15:59:56 +00:00
2019-07-07 21:31:20 +00:00
## Cahier des Charges
2019-07-07 21:36:04 +00:00
Il est disponible [ici](https://wiki.crans.org/NoteKfet/NoteKfet2018/CdC).
2019-07-07 21:31:20 +00:00
## Documentation
La documentation est générée par django et son module admindocs. **Commenter votre code !*