From d98d395bdff2be0051044d94193f65c4e2e7335d Mon Sep 17 00:00:00 2001
From: Dana Lambert <danalambert@catalyst.net.nz>
Date: Wed, 6 Oct 2021 14:53:51 +1300
Subject: [PATCH] Add development environment documentation to README

---
 .gitignore |  1 -
 README.md  | 47 ++++++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 46 insertions(+), 2 deletions(-)
 delete mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
deleted file mode 100644
index 5ceb386..0000000
--- a/.gitignore
+++ /dev/null
@@ -1 +0,0 @@
-venv
diff --git a/README.md b/README.md
index 50f3e49..1fda6fa 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,48 @@
 # RightTree
 
-Right Plant Right Place Right Time implementation using React and Django.
\ No newline at end of file
+Right Plant Right Place Right Time implementation using React and Django.
+
+## Running application for development
+### Initial Setup
+
+Before running the applications please ensure the following prerequisites have been met.
+#### Software
+Most applications in this repository are built using Docker which resolves many dependencies but you will require a local installation of `git`, `docker` and `docker-compose`.
+
+```bash
+$ sudo apt install git docker-compose
+```
+
+To install `docker`, follow the [official installation documentation](https://docs.docker.com/get-docker/). [Instructions are also available for `docker-compose`](https://docs.docker.com/compose/install/).
+
+#### Initialise database
+
+Creates `right_tree` database and installs `postgis` extensions.
+
+```
+chmod +x ./database/init_database.sh
+./database/init_database.sh
+```
+
+#### Initial build
+
+Builds the Django backend docker image. This may need to be re-run if any new dependencies are added.
+```
+docker-compose build
+```
+
+### Run web application
+
+Starts up the applications including the frontend, backend and database.
+
+```
+docker-compose up
+```
+
+Once running the components can be accessed as follows:
+
+| Application | Hosted |
+| --- | --- |
+| React Frontend | http://localhost:3000 |
+| Django Backend | http://localhost:8000 |
+| Database | postgis://localhost:5432 |
\ No newline at end of file