diff --git a/README.md b/README.md
index 897f932..90b5cb8 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,17 @@
## Présentation
-
+
-La Chariotte est une application web sous licence libre Affero GPL, développée et maintenue par [Hashbang](https://hashbang.fr/).
+La Chariotte est une application de gestion de commandes groupées.
+
+Elle est publiée sous licence libre Affero GPL, développée et maintenue par [Hashbang](https://hashbang.fr/).
## Contribuer
Si vous souhaitez contribuer au projet de la Chariotte, merci beaucoup !
-Pour cela, une fois que vous avez cloné le projet et obtenu le statut de développeur sur le projet GitLab, vous pouvez :
+La permière étape est de cloner le projet et d'obtenir le statut de développeur. Une fois que c'est fait, vous pouvez :
- choisir une tâche dans le board que vous voulez réaliser, et vous l'assigner - si vous ne savez pas quelle tâche faire, n'hésitez pas à écrire à laetitia@chariotte.fr
- créer une nouvelle branche **à partir de develop** dont le nom dira ce que vous voulez faire
@@ -37,16 +39,10 @@ La version est à mettre à jour dans `la_chariotte.__init__.py` lors des releas
Cloner le projet :
```bash
-git clone https://gitlab.com/hashbangfr/la_chariotte.git
+git clone git@gitlab.com:hashbangfr/la_chariotte.git
```
-Installer les dépendances :
-```bash
-pip install -r requirements.txt
-pip install -r dev-requirements.txt
-```
-
-### Installation d'un environnement virtuel
+### Environnement virtuel.
Pour éviter que les bibliothèques nécessaires au projet ne rentrent en conflit avec celles de votre système, il peut être utile d'installer un environnement virtuel :
@@ -60,12 +56,22 @@ Une fois l'environnement virtuel installé, vous pouvez l'activer :
source .venv/bin/activate
```
-### Installation de la base de données
+### Dépendances
+
+Installer les dépendances :
+```bash
+pip install -r requirements.txt
+pip install -r dev-requirements.txt
+```
+
+### Base de données
La Chariotte nécessite une base de données, et est actuellement compatible avec PostgreSQL ([instructions d'installation ici](https://www.digitalocean.com/community/tutorials/how-to-install-postgresql-on-ubuntu-20-04-quickstart)).
Pour le développement, nous vous conseillons de créer une base de données nommée ```chariotte``` accessible par l'utilisateur et le mot de passe du même nom.
+Dans une invite postgresql, entrez ceci :
+
```SQL
CREATE ROLE chariotte WITH
LOGIN
@@ -86,7 +92,7 @@ CREATE DATABASE chariotte
IS_TEMPLATE = False;
```
-### Création du fichier de configuration
+### Fichier de configuration
Créez un fichier de configuration dans lequel vous pourrez spécifier la configuration qui est utile pour vous. Nous allons le nommer ici ```local_settings.py```.
@@ -94,12 +100,12 @@ Créez un fichier de configuration dans lequel vous pourrez spécifier la config
from la_chariotte.settings import *
DATABASES = {
- 'default': {
- 'ENGINE': 'django.db.backends.postgresql',
- 'NAME': 'chariotte',
- 'USER': 'chariotte',
- 'PASSWORD': 'chariotte',
- 'HOST': 'localhost',
+ "default": {
+ "ENGINE": "django.db.backends.postgresql",
+ "NAME": "chariotte",
+ "USER": "chariotte",
+ "PASSWORD": "chariotte",
+ "HOST": "localhost",
}
}
```
@@ -117,26 +123,28 @@ Pour créer un superutilisateur, qui aura accès à l'interface admin (/admin) :
python manage.py createsuperuser
```
-
### Travailler sur le frontend
-install bulma
+Nous utilisons bulma comme framework CSS. Vous pouvez l'installer en utilisant la commande suivante :
+
```bash
npm install bulma
```
-check sass version
+Vérifiez que vous utilisez la bonne version de sass :
+
```bash
sass --version
# used for developement: 1.59.3 compiled with dart2js 2.19.4
```
-watch for changes when updating scss files (from project root)
+Recompiler dès que des changements sont detectés dans les fichiers scss.
+
```bash
sass --watch --no-source-map ./la_chariotte/static/sass/style.sass:./la_chariotte/static/css/app.css
```
-OR compile css only once (from project root)
+Ou bien préférez compiler vers CSS au coup à coup :
```bash
sass --no-source-map ./la_chariotte/static/sass/style.sass:./la_chariotte/static/css/app.css
```
@@ -148,19 +156,21 @@ Lancer les tests avec pytest :
pytest
```
-Si il y a des erreurs ISORT, on peut lancer isort pour trier les fichiers :
+Si il y a des erreurs [isort](https://pycqa.github.io/isort/), on peut lancer isort pour trier les fichiers :
+
```bash
isort .
```
-Si il y a des erreurs BLACK, on peut lancer black pour linter le code :
+Si il y a des erreurs [black](https://black.readthedocs.io/en/stable/), on peut lancer black pour linter le code :
+
```bash
black .
```
-## Tests de l'envoi de mails
+### Tests de l'envoi de mails
-Pour tester l'apparence des mails, on peut utiliser Sendria :
+Pour tester l'apparence des mails, on peut utiliser [Sendria](https://github.com/msztolcman/sendria) :
```bash
pip install sendria
sendria --db mails.sqlite