Merge branch 'pre-prod' of https://gitea.woutervermeer.com/woutervermeer/Quatsh-Website into pre-prod
All checks were successful
Gitea build & Test. / tests (push) Successful in 18s
All checks were successful
Gitea build & Test. / tests (push) Successful in 18s
This commit is contained in:
42
README.md
42
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
|
||||
```
|
||||
Reference in New Issue
Block a user