From a77feb21c3567925d8f41c5fea526f5363bfcf24 Mon Sep 17 00:00:00 2001
From: Reinout van Rees <reinout@vanrees.org>
Date: Tue, 12 Mar 2024 15:41:55 +0100
Subject: [PATCH 1/3] .md syntax fix

---
 README.md | 16 ++++------------
 1 file changed, 4 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index e9221de..9f603f3 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,13 @@
 # BRO-Hub
 
-Introductie
-------------
+## Introductie
 
 BRO-hub is een allomvattend product voor het datamanagement rondom de BRO. Het bestaat uit een API om zowel data uit de BRO te importeren als data naar de BRO op te sturen. De geimporteerde data wordt opgeslagen in een database en is via de API op te vragen.
 
 De backend is een Django applicatie, en de frontend (voorlopig) een Streamlit dashboard.
 
-Project beschrijving
------------------
+## Project beschrijving
+
 De backend bestaat uit een api met daarin:
 
 - Een importtask endpoint. Hiermee kan op basis van een KvK en projectnummer alle actuele data van een BRO domein geimporteerd worden
@@ -17,8 +16,7 @@ De backend bestaat uit een api met daarin:
 
 - Endpoints voor alle assets die uit de BRO worden geimporteerd.
 
-Installatie backend
------------------------
+## Installatie backend
 
 (Voorlopig moet alles nog zelf lokaal opgezet te worden. Hopelijk wordt een groot deel via docker opgezet in de toekomst, daarom is deze omschrijving nogal beperkt in details)
 
@@ -52,9 +50,3 @@ Om het lokaal te installeren:
 
 
 Nu kan het product gebruikt worden.
-
-Installatie frontend (temp strealit)
---------------------
-Start the frontend with:
-
-        $ streamlit run streamlit/Home.py

From 482fe934e672af056ce318956bfafe1d8c0d9e4d Mon Sep 17 00:00:00 2001
From: Reinout van Rees <reinout@vanrees.org>
Date: Tue, 12 Mar 2024 15:55:42 +0100
Subject: [PATCH 2/3] Removing the venv part from pyright/vscode for now as we
 run in docker

---
 pyproject.toml | 2 --
 1 file changed, 2 deletions(-)

diff --git a/pyproject.toml b/pyproject.toml
index 1a76063..d97c48b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -42,5 +42,3 @@ release = false
 
 [tool.pyright]
 include = ["bro_hub", "api", "gmn", "gmw"]
-venvPath = "."
-venv = ".venv"

From ac428a6cb315f4fac4e1e20b35aa01de38fe92b8 Mon Sep 17 00:00:00 2001
From: Reinout van Rees <reinout@vanrees.org>
Date: Tue, 12 Mar 2024 16:00:42 +0100
Subject: [PATCH 3/3] Added dev instructions

---
 README.md | 34 ++++++++++++----------------------
 1 file changed, 12 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index 9f603f3..7d5d918 100644
--- a/README.md
+++ b/README.md
@@ -18,35 +18,25 @@ De backend bestaat uit een api met daarin:
 
 ## Installatie backend
 
-(Voorlopig moet alles nog zelf lokaal opgezet te worden. Hopelijk wordt een groot deel via docker opgezet in de toekomst, daarom is deze omschrijving nogal beperkt in details)
+To install for development:
 
-Om het lokaal te installeren:
+    $ docker-compose build
+    $ docker-compose pull
+    $ pip install pre-commit  # Just needed once for your laptop.
 
-1) Clone de repo, maak een venv aan, en installeer de requirements.
+It uses a database within docker-compose. TODO: add celery/redis.
 
-2) Maak een database aan
+Some instructions:
 
-3) Makemigrations, migrate, createsuperuser
+    $ docker-compose up  # Starts the site on localhost:8000
+    $ docker-compose run --rm web pytest
+    $ docker-compose run --rm web python manage.py migrate
+    $ pre-commit run --all  # runs the formatter, checks, etc.
 
-4) Start een redis server lokaal
+Do the regular migrate, createsuperuser stuff.
 
-5) start de django applicatie: python manage.py runserver
-
-6) start celery op: celery -A bro_hub worker -l INFO -P solo
+TODO: start celery automatically (`celery -A bro_hub worker -l INFO -P solo`)
 
 7) Maak een organisatie, vul de KvK in
 
 8) Maak een user profile aan voor de superuser, en vul het project en evt bro authenticatie in
-
-9) De bro auth gegevens worden geencrypt. Hiervoor is een FIELD_ENCRYPTION_KEY nodig. Om deze aan te maken, run hetvolgende:
-
-        $ import os
-        import base64
-
-        new_key = base64.urlsafe_b64encode(os.urandom(32))
-        print(new_key)
-
-    Sla de key (zonder de b'' bytes structuur) op in een .env.
-
-
-Nu kan het product gebruikt worden.