Skip to content

Commit

Permalink
#80: Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
keiranjprice101 committed Oct 18, 2019
1 parent 611dd2a commit 0386de2
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,14 @@ The required python libraries:
## Setup and running the API
The database connection needs to be set up first. This is set in config.json, an example config file called `config.json.example` is provided.


To run the API from the command line, the enviroment variable `FLASK_APP` should be set to `src/main.py`. Once this is
Ideally the API would be run with:
`python -m src.main`
However it can be run with the flask run command as shown below:


**Warning: the host, port and debug config options will not be respected when the API is run this way**

To use `flask run`, the enviroment variable `FLASK_APP` should be set to `src/main.py`. Once this is
set the API can be run with `flask run` while inside the root directory of the project. The `flask run` command gets installed with flask.

Examples shown:
Expand Down

0 comments on commit 0386de2

Please sign in to comment.