diff --git a/README.md b/README.md index 2de36fb..7ae2e8d 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,13 @@ ___ ## How to run In ordre to run the server you will need ```python3``` and ```python3-pip```. -Then yo install the depedencies run ```pip install -r requirement.txt```. +Then to install the depedencies run ```pip install -r requirement.txt```. If you want to contribute you may install the dev dependecies as well : ```pip install -r dev-requirement.txt``` -To launch the web server just run the command ```flask run``` +You will need to create the .env file from the .env.dist and fill the parameters. Do take note that this website was conceived to run on a mariadb sql database, however this can be easly changed in the data_access.py file. In order to fill the remote database with the data availible in this repo you will need to run the remote.py script : ```python3 truthinquiry/logic/data_persistance/remote.py ``` -To run the test run the command ```python -m pytest --verbose``` +To launch the web server just run the command ```flask run``` +To run the test run the command ```python3 -m pytest --verbose``` ## Contributors