DjalimSimaila/SAE-A2-TruthInquiry
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #57 from ThomasRubini/readme

Browse Source 
typos
This commit is contained in:
Djalim Simaila 2023-01-16 10:47:41 +01:00 committed by GitHub
commit e9dee419b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -14,19 +14,25 @@ ___
## How to run ## How to run
In ordre to run the server you will need ```python3``` and ```python3-pip```. In ordre to run the server you will need ```python3``` and ```python3-pip```.
Then to 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``` If you want to contribute you may install the dev dependecies as well : ```pip install -r dev-requirement.txt```
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 ``` 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 launch the web server just run the command ```flask run``` To launch the web server just run the command ```flask run```.
To run the test run the command ```python3 -m pytest --verbose```
To run the tests, run the command ```python3 -m pytest --verbose```.
## Contributors ## Contributors
[BIGA Paul](https://github.com/SujetDelta) [BIGA Paul](https://github.com/SujetDelta)
[CAZALS Matthias](https://github.com/mathiascazals) [CAZALS Matthias](https://github.com/mathiascazals)
[RUBINI Thomas](https://github.com/ThomasRubini) [RUBINI Thomas](https://github.com/ThomasRubini)
[SIMAILA Djalim](https://github.com/DjalimSimaila) [SIMAILA Djalim](https://github.com/DjalimSimaila)
[V Audric](https://github.com/AudricV) [V Audric](https://github.com/AudricV)