Skip to content

Commit fe4e3fe

Browse files
committed
Added installation and usage instructions
1 parent 03257fe commit fe4e3fe

File tree

2 files changed

+23
-1
lines changed

2 files changed

+23
-1
lines changed

.env.example

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
export TESTING=1
2+
export PYTHONUNBUFFERED=1
3+
export OAUTH2_ACTIVE=0
4+
export LOG_LEVEL=DEBUG
5+
export WEBSOCKET_BROADCASTER_URL="redis://localhost:6379"

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,21 @@ Example workflow orchestrator
44
(https://workfloworchestrator.org/orchestrator-core/) implementation.
55

66
**Note: work in progress; first version expected to be released by the end
7-
of 2023**
7+
of 2023**
8+
9+
## Quickinstall
10+
11+
Create a venv, then run these commands:
12+
13+
```
14+
pip install -r requirements.txt
15+
python main.py db upgrade heads
16+
python -u -m uvicorn --reload --workers 4 --host 0.0.0.0 --port 8080 main:app
17+
```
18+
19+
This assumes a environment that has correct settings or it will use the orchestrator-core defaults (like DB name orchestratorc-core).
20+
21+
And example is in `.env.example`
22+
23+
You can find a list with default settings [here](https://github.com/workfloworchestrator/orchestrator-core/blob/main/orchestrator/settings.py)
24+

0 commit comments

Comments
 (0)