From 885889ecba817c3fed4adbf86b005f9be72d2d74 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Timoth=C3=A9e=20Poussard?= <tpoussard@neogeo.fr>
Date: Wed, 18 Aug 2021 11:12:58 +0200
Subject: [PATCH] Update ReadMe

---
 README.md | 67 +++++++++++++++++++++++++++++--------------------------
 1 file changed, 35 insertions(+), 32 deletions(-)

diff --git a/README.md b/README.md
index 6005ea55..8a045449 100644
--- a/README.md
+++ b/README.md
@@ -5,7 +5,33 @@
 npm install
 ```
 
+### Préparation des variables d'environnement
+Créer un fichier .env à la racine du projet puis ajouter les variables comme indiquer dans l'exemple ci-dessous (à adapter en fonction de l'environnement d'exploitation).
+
+
+```ini
+DOMAIN=http://127.0.0.1:8010
+
+NODE_ENV=development
+VUE_APP_LOCALE=fr-FR
+# AUTH
+VUE_APP_APPLICATION_NAME=GéoContrib
+VUE_APP_APPLICATION_ABSTRACT=Application de saisie d’informations géographiques contributive
+VUE_APP_LOGO_PATH=@/assets/img/logo-neogeo-circle.png
+VUE_APP_DJANGO_API_BASE=http://localhost:8010/api/
+
+```
+
 ### Compiles and hot-reloads for development
+
+Pour éviter les problèmes de Cors en dév, (car backend sur serveur différent de frontend, différent en prod car même serveur), on utilise un proxy qui s'occupe de renseigner les CORS: https://github.com/garmeeh/local-cors-proxy#local-cors-proxy  
+
+**À installer avant de lancer le serveur !**  
+```
+npm install -g local-cors-proxy
+```
+
+La commande serve lance les deux serveurs en parallèle dans le même terminal.
 ```
 npm run serve
 ```
@@ -21,9 +47,9 @@ npm run lint
 ```
 
 ### Customize configuration
-See [Configuration Reference](https://cli.vuejs.org/config/).
-
+See [Configuration Reference](https://cli.vuejs.org/config/).  
 
+---
 ## Docker
 
 Lancer un build
@@ -46,34 +72,11 @@ et
 ```
 docker-compose up -d
 ```
+---
+## Notes
+### Changement par rapport au projet django
+- Base.html => App.vue
+- Découpage en composants
 
-## Changement depuis django
-- Base.html = App.js
-
-## Divers
-- Vue-frag permet d'avoir plusieurs éléments html à la racine du template d'un compposant (comme les fragments dans React), sans avoir à ajouter une div wrapper qui peut modifier le style, si on a une classe parente avec du flex par exemple. Cela permet de garder la même structure de pages que les templates originaux dans Django.
-
-# Dev
-
-Pour éviter les problèmes de Cors en dév, car backend sur serveur différent de frontend (en prod même serveur), on utilise un proxy qui s'occupe de renseigner les CORS: https://github.com/garmeeh/local-cors-proxy#local-cors-proxy
-
-La commande serve lance les deux serveurs en parallèle.
-
-### Préparation des variables d'environnement
-Créer un fichier .env à la racine du projet puis ajouter les variables comme indiquer dans l'exemple ci-dessous (à adapter en fonction de l'environnement d'exploitation).
-
-
-```ini
-DOMAIN=http://127.0.0.1:8010
-
-NODE_ENV=development
-VUE_APP_LOCALE=fr-FR
-# AUTH
-VUE_APP_LOGIN_API_USERNAME=admin
-VUE_APP_LOGIN_API_PASSWORD=admin
-VUE_APP_APPLICATION_NAME=GéoContrib
-VUE_APP_APPLICATION_ABSTRACT=Application de saisie d’informations géographiques contributive
-VUE_APP_LOGO_PATH=@/assets/img/logo-neogeo-circle.png
-VUE_APP_DJANGO_API_BASE=http://localhost:8010/api/
-
-```
\ No newline at end of file
+### Divers
+- Afin de garder la même structure de pages que les templates originaux dans Django et aller vite, on utilise Vue-frag qui permet d'avoir plusieurs éléments html à la racine du template d'un compposant (comme les fragments dans React), sans avoir à ajouter une div wrapper qui pourait modifier le style (si on a une classe parente avec du flex par exemple).
-- 
GitLab