diff --git a/.gitignore b/.gitignore index 45e7bbe6d..934d2adbb 100644 --- a/.gitignore +++ b/.gitignore @@ -46,6 +46,7 @@ coverage.xml *.cover .hypothesis/ .pytest_cache/ +*test*.xml # Translations *.mo diff --git a/README.md b/README.md index 319b556d1..8cb31ee12 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,26 @@ When you submit a pull request, a CLA-bot automatically determines whether you n * This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). * For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or * Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. + +## Running Instructions + +Execute the following commands: + +```shell +virtualenv env +source env/bin/activate +pip install -r requirements.txt +pip install gunicorn +gunicorn --bind=0.0.0.0 --workers=4 startup:app +``` + +The server will serve at http://127.0.0.1:8000/ + +### Test + +Execute the following commands: + +```shell +pip install pytest +pytest test*.py --junit-xml=test-results.xml +``` \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index af2376e97..7a0111637 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,5 +2,5 @@ click==6.7 Flask==1.0.2 itsdangerous==0.24 Jinja2>=2.10.1 -MarkupSafe==1.0 +MarkupSafe==1.1.1 Werkzeug==0.15.5