diff --git a/docs/guide/connectors/ecf/node-js.mdx b/docs/guide/connectors/ecf/node-js.mdx index bfa488c5..02244959 100644 --- a/docs/guide/connectors/ecf/node-js.mdx +++ b/docs/guide/connectors/ecf/node-js.mdx @@ -6,26 +6,27 @@ This tutorial guides you through creating a Node.js-based web server that adhere 1. Node.js: Download and install Node.js from the official website: [nodejs.org](https://nodejs.org/en/download) 2. Open API Specification: Download the ECF Open API specification file from GitHub: [Open API Spec](https://github.com/saviynt/ExternalConnectorFramework-APISpec/blob/main/spec/OpenAPISpec.yaml). -3. IDE: Choose your preferred IDE (Integrated Development Environment) for Node.js development, such as Visual Studio. +3. IDE: Choose your preferred IDE (Integrated Development Environment) for Node.js development, such as [Visual Studio](https://visualstudio.microsoft.com/downloads/). ## Steps to generate node-js server bundle. -1. Open Swagger Editor in web broswer by navigating to [swagger.io](https://editor.swagger.io/) -2. In the editor window, click on File --> Import file and select the OpenAPISpec.yaml. -3. You should be able to render the API specification on right panel. -4. Now go to Generate Server -> nodejs-server -5. This will generate a zip file. +1. Open Swagger Editor: Launch the Swagger Editor in your web browser by visiting: [swagger.io](https://editor.swagger.io/) +2. Import Open API Spec: In the editor window, click File > Import File and select the downloaded OpenAPISpec.yaml file. +3. Render API Specification: The API specification should be displayed on the right panel. +4. Generate Server Code: Go to Generate Server > nodejs-server. +5. Download Server Bundle: This action will generate a ZIP file containing the Node.js server code. ## Steps to start node-js server. -1. Unzip the generated zip file. (This will be base location of your node js project) -2. Go to base location and run ```npm start``` command. -3. You should be able to see below message. - -Your server is listening on port 8080 [localhost](http://localhost:8080) +1. Unzip Server Bundle: Extract the downloaded ZIP file to create your Node.js project directory. +2. Navigate to Project Directory: Open your terminal or command prompt and navigate to the unzipped project directory. +3. Run Server: Execute the command npm start to start the server. +4. Server Confirmation: Upon successful execution, you should see a message similar to: +``` +Your server is listening on port 8080 (http://localhost:8080) Swagger-ui is available on [/docs](http://localhost:8080/docs) - -This will mean you have successfully started the node-js server. +``` +This indicates that your Node.js server is running and accessible. ## Steps to explore the API spec.