slightly updated README.md
Some checks failed
Gitea build & Test. / tests (push) Failing after 7s

This commit is contained in:
WGAVermeer
2026-03-26 08:27:10 +01:00
parent c17e3e85f2
commit 49199b7184

View File

@@ -1,44 +1,65 @@
# Quatsh-Website # Quatsh-Website
## Requirements: ## Requirements
### Install make ### Install make
Running this requires the use of "make" and docker. 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: \ "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 choco install make
``` ```
### Install docker ### Install docker
https://docs.docker.com/get-started/get-docker/
<https://docs.docker.com/get-started/get-docker/>
## Running for the first time ## Running for the first time
### Env ### Env
Before running the container environment has to be setup first, so first run: Before running the container environment has to be setup first, so first run:
``` ```
cp .env.template .env 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 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. 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 make dev
``` ```
#### Testing #### Testing
Runs the testing environment and exits. Runs the testing environment and exits.
```
```shell
make test make test
``` ```
#### Production #### Production
Using `make prod` is identical but preferred here. Using `make prod` is identical but preferred here.
```
```shell
make prod make prod
# or ```
Or
```shell
make make
``` ```