Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jae1911 committed Dec 12, 2021
1 parent a7d8b45 commit 66c4c53
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
# Wolfeye API

This is the repository for the Wolfeye API.
It is made to run with Traefik as a reverse proxy.

## Local dev

This requires a Redis server listening in local.

Quickstart dev windows (using powershell):
```
python -m venv venv
.\venv\Scripts\Activate.ps1
pip install -r requirements.txt
$env:FLASK_APP = "main"
$env:FLASK_ENV = "development"
$env:REDIS_HOST = "localhost"
flask run
```

Quickstart dev linux:
```
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
export FLASK_APP="main"
export FLASK_ENV="development"
export REDIS_HOST="localhost"
flask run
```

0 comments on commit 66c4c53

Please sign in to comment.