# 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 changes 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.
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

```shell
make
```