Compare commits

...

5 Commits

Author SHA1 Message Date
df587931b5 Merge pull request 'woutervermeer-patch-1' (#14) from woutervermeer-patch-1 into pre-prod
Some checks failed
Gitea build & Test. / tests (push) Failing after 3s
Reviewed-on: woutervermeer/Quatsh-Website#14
2026-03-11 08:23:40 +00:00
357c81ff08 Update README.md
All checks were successful
Gitea build & Test. / tests (pull_request) Successful in 6s
2026-03-11 07:30:02 +00:00
026bce1f16 Merge pull request 'Update README.md' (#13) from woutervermeer-patch-1 into main
All checks were successful
Deploy to production / deploy (push) Successful in 18s
Reviewed-on: woutervermeer/Quatsh-Website#13
2026-03-09 12:41:08 +00:00
b1f44f2ce0 Update README.md
All checks were successful
Gitea build & Test. / tests (pull_request) Successful in 6s
2026-03-09 12:40:37 +00:00
761227e05e Merge pull request 'pre-prod' (#12) from pre-prod into main
All checks were successful
Deploy to production / deploy (push) Successful in 19s
Reviewed-on: woutervermeer/Quatsh-Website#12
2026-03-08 14:34:16 +00:00

View File

@@ -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
```