Updated line endings to be in line with UNIX style
This commit is contained in:
84
README.md
84
README.md
@@ -1,43 +1,43 @@
|
||||
---
|
||||
runme:
|
||||
id: 01HK0BF4BTBSKR9VWAP1KGD2S7
|
||||
version: v2.0
|
||||
---
|
||||
|
||||
# WMGZON
|
||||
|
||||
`Flask web application serving WMGZON and its relevant backend services.`
|
||||
|
||||
## Initialisation
|
||||
|
||||
To start you need to create a virtual environment and load in the required dependencies for the project
|
||||
|
||||
```sh {"closeTerminalOnSuccess":"false","id":"01HK0BJCK9BR05J127F1X0RZP9"}
|
||||
python -m venv .venv
|
||||
./.venv/Scripts/Activate.ps1
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
To run the full suite of unit tests for the webapp simply run the following command in the venv
|
||||
```sh
|
||||
pytest
|
||||
```
|
||||
|
||||
## Running
|
||||
|
||||
### Pre-Requisites
|
||||
|
||||
- Docker daemon is installed and running.
|
||||
- Docker compose is installed.
|
||||
|
||||
### Instructions
|
||||
|
||||
In order to run the web app, simply use the command
|
||||
|
||||
```sh {"id":"01HKD0VRADDYQ92W22JN1FHA03"}
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
runme:
|
||||
id: 01HK0BF4BTBSKR9VWAP1KGD2S7
|
||||
version: v2.0
|
||||
---
|
||||
|
||||
# WMGZON
|
||||
|
||||
`Flask web application serving WMGZON and its relevant backend services.`
|
||||
|
||||
## Initialisation
|
||||
|
||||
To start you need to create a virtual environment and load in the required dependencies for the project
|
||||
|
||||
```sh {"closeTerminalOnSuccess":"false","id":"01HK0BJCK9BR05J127F1X0RZP9"}
|
||||
python -m venv .venv
|
||||
./.venv/Scripts/Activate.ps1
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
To run the full suite of unit tests for the webapp simply run the following command in the venv
|
||||
```sh
|
||||
pytest
|
||||
```
|
||||
|
||||
## Running
|
||||
|
||||
### Pre-Requisites
|
||||
|
||||
- Docker daemon is installed and running.
|
||||
- Docker compose is installed.
|
||||
|
||||
### Instructions
|
||||
|
||||
In order to run the web app, simply use the command
|
||||
|
||||
```sh {"id":"01HKD0VRADDYQ92W22JN1FHA03"}
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
to run the container in a detatched mode.
|
||||
Reference in New Issue
Block a user