Skip to content

Commit dd13735

Browse files
chore: docs update (#14)
Because - docs update This commit - docs update
1 parent 30728a5 commit dd13735

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed

ReadMe.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,28 @@ import { Pipeline, listPipelinesQuery } from "@instill-ai/typescript-sdk";
2121
2222
```
2323

24+
### config
25+
26+
- `.env`
27+
```
28+
API_VERSION=v1alpha
29+
INSTILL_AI_USER_COOKIE_NAME=instill-ai-user
30+
APP_EDITION=local-ce:dev
31+
API_GATEWAY_URL=http://localhost:8080
32+
SELF_SIGNED_CERTIFICATION=false
33+
DISABLE_CREATE_UPDATE_DELETE_RESOURCE=false
34+
LIST_PAGE_SIZE=6
35+
USAGE_COLLECTION_ENABLED=true
36+
SET_SECURE_COOKIE=false
37+
AMPLITUDE_KEY=9823fa6e3ff904bec67a8fc90db82fb9
38+
APP_BASE_URL=http://localhost:3000
39+
MGMT_BACKEND_BASE_URL=http://localhost:8084
40+
PIPELINE_BACKEND_BASE_URL=http://localhost:8081
41+
CONNECTOR_BACKEND_BASE_URL=http://localhost:8082
42+
MODEL_BACKEND_BASE_URL=http://localhost:8083
43+
```
44+
45+
2446

2547
## API Reference
2648

examples/next-app/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,27 @@ pnpm add @instill-ai/typescript-sdk
1616

1717
- make sure you have vdp up running, to run vdp check this [vdp](https://github.com/instill-ai/vdp)
1818
- verify `.env`
19+
20+
```
21+
API_VERSION=v1alpha
22+
INSTILL_AI_USER_COOKIE_NAME=instill-ai-user
23+
APP_EDITION=local-ce:dev
24+
API_GATEWAY_URL=http://localhost:8080
25+
SELF_SIGNED_CERTIFICATION=false
26+
DISABLE_CREATE_UPDATE_DELETE_RESOURCE=false
27+
LIST_PAGE_SIZE=6
28+
USAGE_COLLECTION_ENABLED=true
29+
SET_SECURE_COOKIE=false
30+
AMPLITUDE_KEY=9823fa6e3ff904bec67a8fc90db82fb9
31+
APP_BASE_URL=http://localhost:3000
32+
MGMT_BACKEND_BASE_URL=http://localhost:8084
33+
PIPELINE_BACKEND_BASE_URL=http://localhost:8081
34+
CONNECTOR_BACKEND_BASE_URL=http://localhost:8082
35+
MODEL_BACKEND_BASE_URL=http://localhost:8083
36+
```
37+
38+
39+
1940
- see the changes done in `_document.tsx` and `next.env.mjs`
2041

2142
### Now You are ready.

examples/node-app/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,24 @@ pnpm add @instill-ai/typescript-sdk
1717
- make sure you have vdp up running, to run vdp check this [vdp](https://github.com/instill-ai/vdp)
1818
- verify `.env`
1919

20+
```
21+
API_VERSION=v1alpha
22+
INSTILL_AI_USER_COOKIE_NAME=instill-ai-user
23+
APP_EDITION=local-ce:dev
24+
API_GATEWAY_URL=http://localhost:8080
25+
SELF_SIGNED_CERTIFICATION=false
26+
DISABLE_CREATE_UPDATE_DELETE_RESOURCE=false
27+
LIST_PAGE_SIZE=6
28+
USAGE_COLLECTION_ENABLED=true
29+
SET_SECURE_COOKIE=false
30+
AMPLITUDE_KEY=9823fa6e3ff904bec67a8fc90db82fb9
31+
APP_BASE_URL=http://localhost:3000
32+
MGMT_BACKEND_BASE_URL=http://localhost:8084
33+
PIPELINE_BACKEND_BASE_URL=http://localhost:8081
34+
CONNECTOR_BACKEND_BASE_URL=http://localhost:8082
35+
MODEL_BACKEND_BASE_URL=http://localhost:8083
36+
```
37+
2038
### Now You are ready.
2139

2240
```

0 commit comments

Comments
 (0)