From f2e0be83b98a9bc3749126095e2aeab46eff8dc2 Mon Sep 17 00:00:00 2001
From: Robbe Van Herck <robbevanherck1@gmail.com>
Date: Thu, 29 Nov 2018 15:46:06 +0100
Subject: [PATCH] Added test script and updatede README.md

---
 README.md | 39 +++++++++++++++++++++++++++++++++++----
 test.py   | 23 +++++++++++++++++++++++
 2 files changed, 58 insertions(+), 4 deletions(-)
 create mode 100644 test.py

diff --git a/README.md b/README.md
index 4e0c610..638208e 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,30 @@
 
 Zoals besproken op de eerste bestuursvergadering.
 
-! Beware: ux is nog verschrikkelijk lelijk, functioneel werkt het wel
+! Beware: UX is nog verschrikkelijk lelijk, functioneel werkt het wel
+
+## Setup
+
+```bash
+# Maak een virtualenv
+virtualenv -p python3 venv
+
+# Activeer de virtualenv
+. ./venv/bin/activate
+
+# Installeer de packages
+pip install -r requirements.txt
+
+# Vraag de Zeus-key en secret aan de dichtsbijzijnde sysadmin en edit config.py
+cp config.example.py config.py
+vim config.py
+
+# Maak de databases
+setup_db.py
+
+# Voor testing (voegt een paar test-users, achievements en endorsements toe aan de db)
+test.py
+```
 
 ## Endpoints
 
@@ -43,11 +66,11 @@ Relatie tussen `User` en `Achievement`
 
 ### /api/users
 
-Returnt een lijst van strings (usernames)
+Returnt een lijst van strings (usernames).
 
 ### /api/achievements
 
-Return een lijst van Achievement-objecten
+Return een lijst van Achievement-objecten.
 
 Achievement-object:
 ```JSON
@@ -61,7 +84,7 @@ Achievement-object:
 
 ### /api/all
 
-Returnt een lijst van User-objecten
+Returnt een lijst van User-objecten.
 
 User-object
 ```JSON
@@ -70,3 +93,11 @@ User-object
     achievement: [Achievement] -> Lijst met achievements van deze persoon
 }
 ```
+
+### /api/dot
+
+Returnt de [GraphViz-dot](https://www.graphviz.org/doc/info/lang.html) notatie van de endorsement-graaf.
+
+### /api/svg
+
+Returnt de svg van de endorsement-graaf.
diff --git a/test.py b/test.py
new file mode 100644
index 0000000..a15095e
--- /dev/null
+++ b/test.py
@@ -0,0 +1,23 @@
+from models import User, Achievement
+from app import db
+
+db.drop_all()
+db.create_all()
+
+persoonA = User(id="AAA")
+persoonB = User(id="BBB")
+persoonC = User(id="CCC")
+
+achievementA = Achievement(name="AA", achieved_by=persoonA.id)
+achievementB = Achievement(name="BB", achieved_by=persoonB.id)
+
+achievementA.endorsed_by.append(persoonC)
+
+db.session.add(persoonA)
+db.session.add(persoonB)
+db.session.add(persoonC)
+
+db.session.add(achievementA)
+db.session.add(achievementB)
+
+db.session.commit()