Neovictorian Paisley Menswear
Have opinions about JavaScript? We want to hear them. Take the 2018 JavaScript Ecosystem Survey »

@scalableminds/chatroom

0.9.1 • Public • Published

React-based Chatroom Component for Rasa Stack

CircleCI

Demo

Watch a demo of our Chatroom in action

Try a live chatbot

Features

  • React-based component
  • Markdown, Images, Buttons
  • Customizable with SASS variables
  • Generates a unique session id and keeps it in sessionStorage
  • Queues consecutive bot messages for better readability
  • Speech input (only in Chrome for now)
  • Demo mode included (ideal for scripted screencasts)
  • Hosted on S3 for easy use
  • Includes a BotServerChannel for use with Rasa Core (under rasa_utils)

Usage

Embed the chatroom.js in the HTML of your website and configure it to connect to your Rasa bot. (see below)

<head>
  <link rel="stylesheet" href="https://npm-scalableminds.s3.eu-central-1.amazonaws.com/@scalableminds/chatroom@master/dist/Chatroom.css" />
</head>
<body>
  <div class="chat-container"></div>
 
  <script src="https://npm-scalableminds.s3.eu-central-1.amazonaws.com/@scalableminds/chatroom@master/dist/Chatroom.js"/></script>
  <script type="text/javascript">
    var chatroom = window.Chatroom({
      host: "http://localhost:5005",
      title: "Chat with Mike",
      container: document.querySelector(".chat-container"),
      welcomeMessage: "Hi, I am Mike. How may I help you?",
      speechRecognition: "en-US"
    });
    chatroom.openChat();
  </script> 
</body>

Note, the version of the Chatroom's Javascript file is encoded in the URL. chatroom@master is always the latest version from the GitHub master branch. Use e.g. chatroom@0.8.2 to load a specific release. All Releases can be found here.

Chatroom Version Compatible Rasa Core Version
0.9.x 0.11.4+
0.8.x 0.11.4+
0.7.8 0.10.4+

Basic usage

  • Clone repository
  • Install frontend dependencies yarn install
  • Build frontend files yarn build
  • Create an HTML page for your Chatroom (see usage example above or modify index.html)
  • Make sure to adjust the host option. Use http://localhost:5005 when testing locally
  • Run yarn serve to launch a web server with your Chatroom on http://localhost:8080
  • Integrate with a Rasa Core project (see standard or custom project below)

Usage with a standard Rasa Core project

  • Copy rasa_utils to your project
  • Install the Python dependencies from rasa_utils/requirements.txt
  • Run your bot with python -m rasa_utils.bot -d models/current/dialogue -u models/current/nlu
  • The bot server will be available at 0.0.0.0:5005

Simple Usage with a custom Rasa Core project on CLI

  • Copy the rasa_utils/bot_server_channel.py to your project
  • Install the Python dependencies from rasa_utils/requirements.txt
  • Create or Modifiy credentials.yml file and add:
rasa_utils.bot_server_channel.BotServerInputChannel:
  # pass
  • Start the Rasa bot using the command line and pass the --credentials flag:
python -m rasa_core.run  \
  --core models/current/dialogue  \
  --nlu models/current/nlu  \
  --endpoints endpoints.yml \
  --credentials credentials.yml

Advanced Usage with a custom Rasa Core project as Custom Channel from Python

  • Copy the rasa_utils/bot_server_channel.py to your project
  • Install the Python dependencies from rasa_utils/requirements.txt
  • Register the BotServerInputChannel with your Rasa Core Agent (see below)
  • Run your bot. By default the bot server will be available at 0.0.0.0:5005
from bot_server_channel import BotServerInputChannel
 
# Creating the Interpreter and Agent 
def load_agent(): ...
 
# Creating the server 
def main_server():
    agent = load_agent()
 
    channel = BotServerInputChannel(agentport=5005)
    agent.handle_channels([channel]http_port=5005)
 
main_server()

Development

Install dependencies

yarn install

Continuously build the Chatroom component

yarn watch
yarn serve

Open http://localhost:8080/demo.html in your browser.

Build

yarn build

Distributable files will be created in folder dist.

License

AGPL v3

Made by scalable minds

Keywords

none

install

npm i @scalableminds/chatroom

Downloadsweekly downloads

10

version

0.9.1

license

AGPL-3.0

last publish

collaborators

  • avatar
Report a vulnerability