From b1f44f2ce0b34c06c0873106416937f4bb301697 Mon Sep 17 00:00:00 2001 From: woutervermeer Date: Mon, 9 Mar 2026 12:40:37 +0000 Subject: [PATCH] Update README.md --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index 3c6bee2..3e91f22 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,44 @@ # Quatsh-Website +## 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: +To run the website 3 options have been provided +#### 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. +``` +make dev +``` + +#### Testing +Runs the testing environment and exits. +``` +make test +``` + +#### Production +Using `make prod` is identical but preferred here. +``` +make prod +# or +make +``` \ No newline at end of file -- 2.49.1