chore: Namananand/ins 2172 update typescript sdk docs (#20)

iamnamananand996 · web-flow · commit 4961eaa4303c · 2023-09-28T16:24:55.000+05:30
Because

- update typescript sdk docs

This commit

- update typescript sdk docs
diff --git a/examples/next-app/README.md b/examples/next-app/README.md
@@ -2,16 +2,24 @@
 
 ### installation
 
+make sure you are on `/typescript-sdk/examples/next-app` folder
+
 ```
-npm i @instill-ai/typescript-sdk
+pnpm install
 ```
+or
+
 ```
-yarn add @instill-ai/typescript-sdk
+npm install
 ```
+
+or
+
 ```
-pnpm add @instill-ai/typescript-sdk
+yarn install
 ```
 
+
 ### config
 
 - make sure you have vdp up running, to run vdp check this [vdp](https://github.com/instill-ai/vdp)
@@ -35,12 +43,16 @@ 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.
 
+```
+pnpm run dev
+```
+
+check http://localhost:3000/
+
 ```
 import { Pipeline, listPipelinesQuery } from "@instill-ai/typescript-sdk";
 
diff --git a/examples/next-app/package.json b/examples/next-app/package.json
@@ -9,7 +9,7 @@
     "lint": "next lint"
   },
   "dependencies": {
-    "@instill-ai/typescript-sdk": "^0.0.3-rc.0",
+    "@instill-ai/typescript-sdk": "^0.0.7",
     "@types/node": "20.6.2",
     "@types/react": "18.2.22",
     "@types/react-dom": "18.2.7",
diff --git a/examples/next-app/pnpm-lock.yaml b/examples/next-app/pnpm-lock.yaml
diff --git a/examples/next-app/src/pages/index.tsx b/examples/next-app/src/pages/index.tsx
@@ -21,5 +21,5 @@ export default function TypescriptSdkDemo() {
       });
   }, []);
 
-  return <div>{JSON.stringify(pipelines)}</div>;
+  return <div>{JSON.stringify(pipelines, null, 4)}</div>;
 }
diff --git a/examples/node-app/README.md b/examples/node-app/README.md
@@ -1,15 +1,20 @@
 ## Config and installation
 
-### installation
+make sure you are on `/typescript-sdk/examples/node-app` folder
 
 ```
-npm i @instill-ai/typescript-sdk
+pnpm install
 ```
+or
+
 ```
-yarn add @instill-ai/typescript-sdk
+npm install
 ```
+
+or
+
 ```
-pnpm add @instill-ai/typescript-sdk
+yarn install
 ```
 
 ### config
@@ -37,6 +42,12 @@ MODEL_BACKEND_BASE_URL=http://localhost:8083
 
 ### Now You are ready.
 
+```
+pnpm run dev
+```
+
+check http://localhost:5000/list-pipelines
+
 ```
 // setup express project
 
diff --git a/examples/node-app/package.json b/examples/node-app/package.json
@@ -4,7 +4,7 @@
   "description": "",
   "main": "index.js",
   "dependencies": {
-    "@instill-ai/typescript-sdk": "^0.0.3-rc.0",
+    "@instill-ai/typescript-sdk": "^0.0.7",
     "dotenv": "^16.3.1",
     "express": "^4.18.2"
   },
diff --git a/examples/node-app/pnpm-lock.yaml b/examples/node-app/pnpm-lock.yaml
diff --git a/examples/node-app/server.js b/examples/node-app/server.js
@@ -3,7 +3,7 @@ const instillAI = require("@instill-ai/typescript-sdk");
 require("dotenv").config(); // Load environment variables from .env file
 
 const app = express();
-const port = process.env.PORT || 3000;
+const port = process.env.PORT || 5000;
 
 // Define a route for listing pipelines using the SDK
 app.get("/list-pipelines", async (req, res) => {

Original file line number	Diff line number	Diff line change
`@@ -21,5 +21,5 @@ export default function TypescriptSdkDemo() {`
`21`	`21`	`});`
`22`	`22`	`}, []);`
`23`	`23`
`24`		`- return <div>{JSON.stringify(pipelines)}</div>;`
	`24`	`+ return <div>{JSON.stringify(pipelines, null, 4)}</div>;`
`25`	`25`	`}`