Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
ozdemirozcelik committed Apr 5, 2023
1 parent 98d5970 commit 9a5fe5e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,10 +164,19 @@ flask run
$env:FLASK_APP = "app.py"
$env:FLASK_ENV = "development"
$env:FLASK_DEBUG = "1"
(below is optional)
$env:DB_ADMIN_PASS = "YOUR_ADMIN_PASSWORD"
flask run
````
browse to "http://127.0.0.1:5000/" to see the dashboard.

you can also define an admin password during the initial creation of the database:
````
(below is optional)
$env:DB_ADMIN_PASS = "YOUR_ADMIN_PASSWORD"
flask run
````

# PostgreSQL with Docker Setup

API is tested and ready to use with PostgreSQL. Default will be SQLite if you don't setup another database.
Expand Down Expand Up @@ -219,6 +228,12 @@ USER1_USERNAME: user1
USER1_PASSWORD: password
```
API also looks for a DB_ADMIN_PASS environment variable during database creation.
```python
admin_password = os.environ.get("DB_ADMIN_PASS", configs.get("SECRET", "ADMIN_PASSWORD"))
```
### resource authorization
needs currently set with Flask- JWT:
Expand Down Expand Up @@ -703,6 +718,12 @@ webhook URL should be: '{URL_OF_YOUR_API}/v4/webhook'
https://api-pairs.herokuapp.com/
demo credentials:
````
username: user1
pass : password
````
# Using with Interactive Brokers
Recommended to be used with Interactive Brokers.
Expand Down

0 comments on commit 9a5fe5e

Please sign in to comment.