From 7b1af75795c6e4dabc42a2303a3a5163219a6575 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Alexis=20M=C3=A9taireau?= <alexis@notmyidea.org>
Date: Mon, 19 Jun 2023 22:46:14 +0200
Subject: [PATCH] Add instructions on how to install locally.

Exmplain how to create the database and how to run the server with
a local settings.py file.
---
 .gitignore |  4 +++-
 README.md  | 67 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 70 insertions(+), 1 deletion(-)

diff --git a/.gitignore b/.gitignore
index 1d84fc8..8065c03 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,4 +4,6 @@ coverage.xml
 la_chariotte.egg-info/
 node_modules
 /static/*
-/media/*
\ No newline at end of file
+/media/*
+local_settings.py
+.venv
\ No newline at end of file
diff --git a/README.md b/README.md
index 5bc4576..cca1d36 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,73 @@ pip install -r requirements.txt
 pip install -r dev-requirements.txt
 ```
 
+### Installation d'un 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 :
+
+```bash
+python3 -m venv .venv
+```
+
+Une fois l'environnement virtuel installé, vous pouvez l'activer :
+
+```bash
+source .venv/bin/activate
+```
+
+### Installation de la base de données
+
+Chariotte nécessite une base de données, et est actuellement compatible avec PostgreSQL.
+
+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.
+
+```SQL
+CREATE ROLE chariotte WITH
+	LOGIN
+	NOSUPERUSER
+	CREATEDB
+	NOCREATEROLE
+	INHERIT
+	NOREPLICATION
+	CONNECTION LIMIT -1
+	PASSWORD 'xxxxxx';
+```
+```SQL
+CREATE DATABASE chariotte
+    WITH
+    OWNER = chariotte
+    ENCODING = 'UTF8'
+    CONNECTION LIMIT = -1
+    IS_TEMPLATE = False;
+```
+
+## Création du 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```.
+
+```python
+from la_chariotte.settings import *
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.postgresql',
+        'NAME': 'chariotte',
+        'USER': 'chariotte',
+        'PASSWORD': 'chariotte',
+        'HOST': 'localhost',
+    }
+}
+```
+
+## Lancement du serveur
+
+Tout devrait être maintenant prêt pour pouvoir lancer le serveur :
+
+```shell
+python manage.py runserver --settings=local_settings
+```
+
+
 ## Travailler sur le frontend
 
 install bulma