/sdk-typescript-example

Primary LanguageTypeScript

i-flow SDK Typescript Example

This example kit provides a robust and professional implementation of the i-flow SDK using Express.js. It includes middleware for JSON parsing and authentication, a health check endpoint, a dynamic services endpoint, and example service endpoints.

Getting Started

Prerequisites

  • Node.js
  • npm

Installation

  1. Clone the repository
git clone https://github.com/your-repo/sdk-example.git
  1. Navigate to the project directory
cd sdk-example
  1. Install the dependencies
npm install
  1. Start the server
npm start

The server will be running on http://localhost:4000.

API Endpoints

  • GET /health: Health check endpoint
  • GET /services: Get a list of available services
  • GET /service1: Example service 1 endpoint
  • POST /service2: Example service 2 endpoint

Building and Running the Docker Container

  1. Build the Docker image:
docker build -t sdk-example .
  1. Build the Docker image:
docker run -p 4000:4000 sdk-example

License

This project is licensed under the MIT License.