From 9fbdb9f3fb8143aba6f2fe03ee9e7ce17876c22e Mon Sep 17 00:00:00 2001 From: Luke Else Date: Fri, 5 Jan 2024 14:39:54 +0000 Subject: [PATCH] Updated readme --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ea9d060..991943a 100644 --- a/README.md +++ b/README.md @@ -16,4 +16,21 @@ To start you need to create a virtual environment and load in the required depen python -m venv .venv ./.venv/Scripts/Activate.ps1 pip install -r requirements.txt -``` \ No newline at end of file +``` + +## Running + +### Pre-Requisites + +- Docker daemon is installed and running. +- Docker compose is installed. + +### Instructions + +In order to run the web app, simply use the command + +```sh {"id":"01HKD0VRADDYQ92W22JN1FHA03"} +docker-compose up -d +``` + +to run the container in a detatched mode. \ No newline at end of file