From f0bb6dfc8f02bc54a48709a8eecbeb419ee79a29 Mon Sep 17 00:00:00 2001
From: Nino <n.van.der.laan@amsterdam.nl>
Date: Thu, 4 Jul 2024 10:19:38 +0200
Subject: [PATCH] add readme

---
 README.md               | 39 +++++++++++++++++++++++++++++++++++++++
 app/apps/cases/tasks.py |  3 ---
 2 files changed, 39 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index 4075db9..5111db7 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,40 @@
 # Zaken Woningkwaliteit Duurzaamheid (ZWD)
+TODO
+
+## Prerequisites
+
+Make sure you have Docker installed locally:
+
+- [Docker](https://docs.docker.com/docker-for-mac/install/)
+
+## Getting up and running (Local development only)
+
+These steps are necessary to make sure all configurations are set up correctly so that you can get the project running correctly.
+
+First, make sure you have built the project and executed the database migrations:
+
+```bash
+docker network create zwd_network
+docker-compose -f docker-compose.local.yml build
+```
+
+Start ZWD backend:
+
+```bash
+docker-compose -f docker-compose.local.yml up
+```
+
+Visit the Admin at http://localhost:8081/admin/
+
+## Django DB migrations
+
+For changes to the model you have to migrate the DB.
+
+```bash
+python manage.py makemigrations --name <name_of_your_migration> <name_of_apps>
+
+python manage.py migrate
+```
+
+name_of_apps is the model you would like to change like: cases, events, workflow or schedules.
+You can use the `---empty` flag to create a custom migration.
diff --git a/app/apps/cases/tasks.py b/app/apps/cases/tasks.py
index 18599f5..363b616 100644
--- a/app/apps/cases/tasks.py
+++ b/app/apps/cases/tasks.py
@@ -1,6 +1,3 @@
-
-
-
 import celery
 
 DEFAULT_RETRY_DELAY = 2