Skip to content

Commit 0d72880

Browse files
committed
docs: readme and comments
1 parent b5adb64 commit 0d72880

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@
22

33
for fetching the apy of different asset on diferrent protocols. For protocols Like for curve, lido, sky, pendle, defillama etc.
44

5+
## Developing
6+
7+
Run `yarn start` to launch app. It will save output to `output.json` file by default. See [config](./src/core/config.ts) for env variables.
8+
59
## Running as docker
610

711
```
812
docker run --rm \
9-
-e ONE_SHOT=true \
1013
-e OUTPUT_JSON=/output/output.json \
1114
-v "$(pwd)/tmp:/output" \
12-
ghcr.io/gearbox-protocol/apy-server:1.1.0-static.1
15+
ghcr.io/gearbox-protocol/apy-server
1316
```
1417

1518
### History

src/core/config.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@ export const IS_DEV = process.env.NODE_ENV !== "production";
33
export const LIDO_AUTH_TOKEN = process.env.LIDO_AUTH_TOKEN;
44
export const RESOLV_AUTH_TOKEN = process.env.RESOLV_AUTH_TOKEN;
55

6+
/**
7+
* Filename to save output to
8+
* If S3_BUCKET is set, it is treated as a key in the bucket.
9+
*/
610
export const OUTPUT_JSON = process.env.OUTPUT_JSON || "output.json";
711

812
export const SENTRY_DSN = process.env.SENTRY_DSN;

0 commit comments

Comments
 (0)