From dd13735e4ca101f708c06a8a54d26552f67061fa Mon Sep 17 00:00:00 2001 From: Naman Anand Date: Mon, 25 Sep 2023 18:50:44 +0530 Subject: [PATCH] chore: docs update (#14) Because - docs update This commit - docs update --- ReadMe.md | 22 ++++++++++++++++++++++ examples/next-app/README.md | 21 +++++++++++++++++++++ examples/node-app/README.md | 18 ++++++++++++++++++ 3 files changed, 61 insertions(+) diff --git a/ReadMe.md b/ReadMe.md index f14e0af..a3ad902 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -21,6 +21,28 @@ import { Pipeline, listPipelinesQuery } from "@instill-ai/typescript-sdk"; ``` +### config + +- `.env` +``` +API_VERSION=v1alpha +INSTILL_AI_USER_COOKIE_NAME=instill-ai-user +APP_EDITION=local-ce:dev +API_GATEWAY_URL=http://localhost:8080 +SELF_SIGNED_CERTIFICATION=false +DISABLE_CREATE_UPDATE_DELETE_RESOURCE=false +LIST_PAGE_SIZE=6 +USAGE_COLLECTION_ENABLED=true +SET_SECURE_COOKIE=false +AMPLITUDE_KEY=9823fa6e3ff904bec67a8fc90db82fb9 +APP_BASE_URL=http://localhost:3000 +MGMT_BACKEND_BASE_URL=http://localhost:8084 +PIPELINE_BACKEND_BASE_URL=http://localhost:8081 +CONNECTOR_BACKEND_BASE_URL=http://localhost:8082 +MODEL_BACKEND_BASE_URL=http://localhost:8083 +``` + + ## API Reference diff --git a/examples/next-app/README.md b/examples/next-app/README.md index a3cec5e..3511a0c 100644 --- a/examples/next-app/README.md +++ b/examples/next-app/README.md @@ -16,6 +16,27 @@ pnpm add @instill-ai/typescript-sdk - make sure you have vdp up running, to run vdp check this [vdp](https://github.com/instill-ai/vdp) - verify `.env` + +``` +API_VERSION=v1alpha +INSTILL_AI_USER_COOKIE_NAME=instill-ai-user +APP_EDITION=local-ce:dev +API_GATEWAY_URL=http://localhost:8080 +SELF_SIGNED_CERTIFICATION=false +DISABLE_CREATE_UPDATE_DELETE_RESOURCE=false +LIST_PAGE_SIZE=6 +USAGE_COLLECTION_ENABLED=true +SET_SECURE_COOKIE=false +AMPLITUDE_KEY=9823fa6e3ff904bec67a8fc90db82fb9 +APP_BASE_URL=http://localhost:3000 +MGMT_BACKEND_BASE_URL=http://localhost:8084 +PIPELINE_BACKEND_BASE_URL=http://localhost:8081 +CONNECTOR_BACKEND_BASE_URL=http://localhost:8082 +MODEL_BACKEND_BASE_URL=http://localhost:8083 +``` + + + - see the changes done in `_document.tsx` and `next.env.mjs` ### Now You are ready. diff --git a/examples/node-app/README.md b/examples/node-app/README.md index 1c2cd95..49d6e53 100644 --- a/examples/node-app/README.md +++ b/examples/node-app/README.md @@ -17,6 +17,24 @@ pnpm add @instill-ai/typescript-sdk - make sure you have vdp up running, to run vdp check this [vdp](https://github.com/instill-ai/vdp) - verify `.env` +``` +API_VERSION=v1alpha +INSTILL_AI_USER_COOKIE_NAME=instill-ai-user +APP_EDITION=local-ce:dev +API_GATEWAY_URL=http://localhost:8080 +SELF_SIGNED_CERTIFICATION=false +DISABLE_CREATE_UPDATE_DELETE_RESOURCE=false +LIST_PAGE_SIZE=6 +USAGE_COLLECTION_ENABLED=true +SET_SECURE_COOKIE=false +AMPLITUDE_KEY=9823fa6e3ff904bec67a8fc90db82fb9 +APP_BASE_URL=http://localhost:3000 +MGMT_BACKEND_BASE_URL=http://localhost:8084 +PIPELINE_BACKEND_BASE_URL=http://localhost:8081 +CONNECTOR_BACKEND_BASE_URL=http://localhost:8082 +MODEL_BACKEND_BASE_URL=http://localhost:8083 +``` + ### Now You are ready. ```