singhalkarun / transport-socket

Deliver UCI messages using socket.

Socket transport layer for UCI Messages

Socket based transport and delivery of messages to and from UCI (since UCI is Rest based only)

[UCI] <---> [Socker Transport Layer] <---> [Frontend]

Features

• Takes request from chatbot client and send it to UCI adapter to get response and return it back to bot client

Tech

• [node.js] - evented I/O for the backend
• [NestJs] - fast node.js network app framework
• [socket.io] - V4.0.0
• [redis] - for socket io redis adapter

Installation

Service requires Node.js v12+ to run.

Clone the repo and set the .env variable

REDIS_PORT={REDIS PORT}
SERVER_PORT={SERVER PORT}
ADAPTER_URL={UCI ADAPTER URL}

Install the dependencies and devDependencies and start the server.

git clone https://github.com/Nik720/bot-socket-service.git
cd bot-socket-service
npm i
npm run start

Docs

• High Level Design