Skip to content
Snippets Groups Projects
Commit 8bf9ef9d authored by florimondmanca's avatar florimondmanca
Browse files

add requirements.txt, update README.md

parent d1ba5bc1
No related branches found
No related tags found
No related merge requests found
......@@ -33,7 +33,32 @@ De nombreuses informations sont également disponibles sur le [Wiki](https://git
:construction_worker_man: Section en construction.
> Lister ici les frameworks, packages et autres technos sur lesquelles le projet s'appuie. Pour chaque dépendance, indiquer comment l'installer (instructions ou lien vers une ressource externe).
> Lister ici les frameworks, packages et autres technos sur lesquelles le projet s'appuie. Pour chaque dépendance, indiquer :
> - la version utilisée ;
> - pour quoi la dépendance est utilisée ;
> - comment l'installer (instructions ou lien vers une ressource externe).
### Backend
#### [Django](https://www.djangoproject.com)
Django est un framework de développement web pour Python.
Le site d'OSER utilise Django en version 2.0.
À l'heure actuelle (05/12/2017), peu de tutoriels Django sont passés à la version 2.0, mais il y a en fait très peu de modifications non-rétro-compatibles par rapport à la version 1.11, et aucune modification n'est réellement critique. Les améliorations apportées par la version 2.0 sont intéressantes, on peut notamment citer le système d'écriture des URLs qui est grandement simplifié.
Pour plus d'infos, lire la [release news](https://www.djangoproject.com/weblog/2017/dec/02/django-20-released/) de Django 2.0.
Django est installé lors de l'installation des `requirements.txt`.
#### [Django REST Framework](http://www.django-rest-framework.org)
Le Django REST Framework (DRF) permet d'écrire facilement des API REST avec Django.
Le site d'OSER utilise le DRF en version 3.7.3. Cette version est entièrement compatible avec Django 2.0.
Le DRF est installé lors de l'installation des `requirements.txt`.
## Installation
......@@ -43,11 +68,23 @@ De nombreuses informations sont également disponibles sur le [Wiki](https://git
1. Clonez ce dépôt sur votre ordinateur :
```
```bash
$ git clone https://github.com/oser-cs/oser-website.git
$ cd oser-website
```
2. Créez un [environnement virtuel](https://github.com/oser-cs/oser-website/wiki/Outils-de-développement-pour-Python#les-environnements-virtuels-avec-virtualenv) puis activez-le :
```bash
oser-website $ virtualenv env -p python3
oser-website $ source env/bin/activate
```
Ceci créera un dossier `oser-website` dans le dossier courant.
3. Installez les dépendances Python :
```bash
(env) oser-website $ pip install -r requirements.txt
```
## Documentation
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment