From 49199b718403bfa5b52b55a53adb91a9625f032b Mon Sep 17 00:00:00 2001 From: WGAVermeer <90707235+WGAVermeer@users.noreply.github.com> Date: Thu, 26 Mar 2026 08:27:10 +0100 Subject: [PATCH] slightly updated README.md --- README.md | 43 ++++++++++++++++++++++++++++++++----------- 1 file changed, 32 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index abd0593..f5e917b 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,65 @@ # Quatsh-Website -## Requirements: +## Requirements ### Install make + Running this requires the use of "make" and docker. "make" tends to come pre-installed on linux but not on Windows, to install it on Windows I recommend using Chocolatey as follows: \ + ``` choco install make ``` ### Install docker -https://docs.docker.com/get-started/get-docker/ + + ## Running for the first time + ### Env + Before running the container environment has to be setup first, so first run: + ``` cp .env.template .env ``` -Then make any nessecary adjustments to the .env file. -### Running the website: +Then make any changes to the .env file. + +### Running the website + To run the website 3 options have been provided -#### Development: + +#### Development + For development purposes only as the src folder has been mounted in the container to allow for the making of changes without rebuilding the entire image. -``` +Properly utilising this also requires the DEBUG environment variable to be set to TRUE. + +```shell make dev -``` +``` #### Testing + Runs the testing environment and exits. -``` + +```shell make test ``` #### Production + Using `make prod` is identical but preferred here. -``` + +```shell make prod -# or +``` + +Or + +```shell make -``` \ No newline at end of file +``` +