Developer's Doc - How to set up and use the portal chatbot client library
This document will help you to how to set up and use a portal chatbot client library.
Background:
This is built as an Angular library. Where this angular library can be integrated into any Angular application(like sunbird portal). Once we integrate this library into the portal user can interact with a bot for his queries by navigating through the options provided by the bot.
Git Repository:
https://github.com/project-sunbird/sunbird-bot-client
Peer dependencies:
socket.io-client v4.0
Dependencies:
https://github.com/samagra-comms/transport-socket
Prerequisite:
Node v10+
Transport socket: Local Setup
sunbird-bot-client library local set-up:
Git clone the sunbird-bot-client library:
> git clone https://github.com/project-sunbird/sunbird-bot-client.git
> cd sunbird-bot-client
> yarn
Now build package with below command and it will generate chat-lib package in the dist folder
npm run build
Available components & service in sunbird-bot-client
Feature | Notes | Selector |
---|---|---|
Chat Window for Chat Bot | lib-chat-window | |
Chat Messages Get Listed in Widget | lib-chat-message-list | |
Library Chat Message Component | lib-chat-message | |
Can be used to send plain text message | lib-chat-message-bottom-bar | |
It has logic to prepare request and store bot responses in chatlist |
| |
it has logic to establish and destroy socket connection between server and client |
|
Integrate the chatbot client library
create a new simple angular application or use any existing angular app to integrate chatbot client
Step 1: Install the package (install from local dist folder by giving full relative path)
npm i sunbird-chatbot-client --save
Step 2: Import the modules and components
Import the NgModule for each component you want to use:
Step 3: Add the library component to the HTML page
botConfig properties:
Step 4: Start the application
How bot-client communicate with the server