generator-jhipster-chatbot-rasa

JHipster module, This module integrates an interface to use with a bot using the Rasa Stack.

Introduction

This is a JHipster module, that is meant to be used in a JHipster application. This module integrates an interface to use with a bot using the Rasa stack. The interface used is from this webchat used on Rasa.

Prerequisites

As this is a JHipster module, we expect you have JHipster and its related tools already installed:

• Installing JHipster

You will also need a bot using the Rasa Stack (Getting started example) and expose it with SocketIO : See instructions in the Rasa Core Documentation, on the react webchat README or on the angular webchat.

Installation

With Yarn

To install this module:

yarn global add generator-jhipster-chatbot-rasa

To update this module:

yarn global upgrade generator-jhipster-chatbot-rasa

With NPM

To install this module:

npm install -g generator-jhipster-chatbot-rasa

To update this module:

npm update -g generator-jhipster-chatbot-rasa

Usage

First, you have to run the generator using the following command :

yo jhipster-chatbot-rasa

Then, you can launch your bot on your own and run the app with :

./mvnw

React

It will modify 2 files (package.json and app.tsx) and you must agree to overwrite them.

If you need to modify some parameters of the widget, it has been added in src/main/webapp/app/app.tsx under

<Footer />

and you can refer to the webchat github to know what you can do with it.

Angular

It will modify 3 files (package.json, app.module.ts and main.component.html) and you must agree to overwrite them.

If you need to modify some parameters of the component, it has been added in src/main/webapp/app/layouts/main/main.component.html

and you can refer to the webchat npm page to know what you can change.

License

MIT © contributionjhipsteruga Julien COURTIAL, Hugo GROS-DAILLON, Cédric LAFRASSE et Bastien TERRIER Our contribution uses the open source work of mrbotai.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.