Skip to content

Commit 8076a46

Browse files
committed
Add start_debug.sh and mention it in readme
1 parent d7100ed commit 8076a46

File tree

4 files changed

+38
-4
lines changed

4 files changed

+38
-4
lines changed

packages/examples/cvat/exchange-oracle/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,23 @@ For deployment it is required to have PostgreSQL(v14.4)
1919
### Run the oracle locally:
2020

2121
```
22-
1. docker-compose -f docker-compose.dev.yml up -d
23-
2. ./bin/start_dev.sh
22+
docker-compose -f docker-compose.dev.yml up -d
23+
./bin/start_dev.sh
2424
```
2525

26+
or
27+
28+
```
29+
docker-compose -f docker-compose.dev.yml up -d
30+
./bin/start_debug.sh
31+
```
32+
33+
When running service from `./bin/start_debug.sh` (`debug.py`), simplified development flow is available:
34+
35+
- When JWT token is required, simple JSON can be used instead of JWT token.
36+
- When webhook signature is required, `{oracle_name}:unique_string` can be used
37+
- You can upload manifest.json to minio `manifests` bucket and use its filename as an escrow_address
38+
2639
### Environemt
2740
Env example file: [.env.example](https://github.com/humanprotocol/human-protocol/blob/feat/cvat/exchange-oracle/packages/examples/cvat/exchange-oracle/src/.env.example)
2841

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
export ENVIRONMENT=development
2+
3+
alembic upgrade head
4+
python debug.py

packages/examples/cvat/recording-oracle/README.MD

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,23 @@ For deployment it is required to have PostgreSQL(v14.4)
1919
### Run the oracle locally:
2020

2121
```
22-
1. docker-compose -f docker-compose.dev.yml up -d
23-
2. ./bin/start_dev.sh
22+
docker-compose -f docker-compose.dev.yml up -d
23+
./bin/start_dev.sh
2424
```
2525

26+
or
27+
28+
```
29+
docker-compose -f docker-compose.dev.yml up -d
30+
./bin/start_debug.sh
31+
```
32+
33+
When running service from `./bin/start_debug.sh` (`debug.py`), simplified development flow is available:
34+
35+
- When webhook signature is required, `{oracle_name}:unique_string` can be used
36+
- You can upload manifest.json to minio `manifests` bucket and use its filename as an escrow_address
37+
38+
2639
### Environemt
2740
Env example file: `/src/.env.example`
2841

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
export ENVIRONMENT=development
2+
3+
alembic upgrade head
4+
python debug.py

0 commit comments

Comments
 (0)