Update README to contain details on install/dev procedures

Summary: Fixes README errors, adds details on install procedure

Test Plan: Check that the Markdown is not broken.

Reviewers: Armteck, corbeaumax

Reviewed By: Armteck

Spies: corbeaumax, Armteck

Maniphest Tasks: T59

Differential Revision: https://phabricator.atilla.org/D32
parent 1b8a2cea
# Eistiens.net v3
## Introduction
Bienvenue sur le dépôt du projet [eistiens.net](http://eistiens.net). Ce projet est géré par l'association [ATILLA](http://atilla.org),
......@@ -9,13 +12,14 @@ Si vous souhaitez participer, n'hésitez pas à nous contacter pour prendre part
## Pré-requis
Il vous sera nécessaire d'utiliser :
Nous vous recommandons fortement d'utiliser virtualenv afin de travailler sur le projet dans un environnement contrôlé. (https://virtualenv.pypa.io/en/stable/). Il vous sera nécessaire d'utiliser :
- arcanist ``` apt-get install arcanist ```
- arcanist ```apt install arcanist```
- python 3.5
- Django 1.9
- virtualenv ```apt install virtualenv```
----------
----------
## Développement
......@@ -33,15 +37,39 @@ rendez vous sur la plateforme de gestion du projet.
## Informations complémentaires
Notre processus de development est détaillé sur [cette page](http://phabricator.atilla.org/w/eistiens-net/code_review_workflow/), et nécessite l'utilisation de Arcanist (voir [ici](https://secure.phabricator.com/book/phabricator/article/arcanist_quick_start/))
1. Avant de travailler sur le projet, et sous conditions que vous utiliez un virtualenv, il est _nécessaire_ d'activer le virtualenv avant de travailler sans quoi les dépendances ne seront pas disponibles.
2. Notre processus de developpement est détaillé sur [cette page](http://phabricator.atilla.org/w/eistiens-net/code_review_workflow/), et nécessite l'utilisation d'Arcanist (voir [ici](https://secure.phabricator.com/book/phabricator/article/arcanist_quick_start/))
----------
## Setup
A la racine du projet (contenant ce README.md et le requirements.txt), exécutez les lignes ci-dessous :
```
$ virtualenv -p `which python3` venv # Create a virtualenv called venv and using local python3 distribution available on your box
$ source venv/bin/activate # You should create an alias of this, you will use this one often
$ pip install -r requirements.txt # Install projet dependancies
```
----------
## Installation des données de base
---
Ce projet, pour permettre aux développeurs de démarrer rapidement à bosser sur la plateforme, contient des _fixtures_ pour initialiser les différentes tables de la BDD sans avoir à le faire à la main. Avant de s'en servir, il est important de s'assurer que la base de donnée est propre (et donc vide afin d'éviter des collisions). Pour faire une installation from scratch de la base, executez les commandes suivantes :
```
$ ./manage.py flush # Flush all data from DB
$ rm db.sqlite3 # Make sure that DB is really empty (destroys it)
$ ./manage.py migrate # Recreate tables in database
$ ./manage.py loaddata */fixtures/*/* # Loads sample data into the database
```
----------
## Fin de développement
Lorsque vous avez terminé de travailler sur Enet, il est important de penser à sortir du virtualenv. Pour ce faire, fermez le terminal ou executez :
```
$ virtualenv -p `which python3` venv
$ source venv/bin/activate
$ pip install -r requirements.txt
$ deactivate
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment