Skip to content

Latest commit

 

History

History
136 lines (97 loc) · 3.96 KB

README.md

File metadata and controls

136 lines (97 loc) · 3.96 KB
Raw

Botpress Extended Skills

Includes some utilities to support you creating innovative chatbots also with community edition.

Custom request

If you would need a custom skill, please let me know via mail.

Requirements

For development, you will only need Node.js and a node global package, Yarn, installed in your environement. Please ensure to install the required Node.js version defined by botpress

Node

  • Node installation on Windows

    Just go on official Node.js website and download the installer. Also, be sure to have git available in your PATH, npm might need it (You can find git here).

  • Node installation on Ubuntu

    You can install nodejs and npm easily with apt install, just run the following commands.

    $ sudo apt install nodejs
$ sudo apt install npm

  • Other Operating Systems

    You can find more information about the installation on the official Node.js website and the official NPM website.

    If the installation was successful, you should be able to run the following command.

    $ node --version
v12.18.4

$ npm --version
[email protected]

    If you need to update npm, you can make it using npm! Cool right? After running the following command, just open again the command line and be happy.

    $ npm install npm -g

Yarn installation

After installing node, this project will need yarn too, so just run the following command.

$ npm install -g yarn

Build the module

This is only a extention module to the botpress project. Hence, we need clone first he botpress project and inject this module into the existing botpress source.

Clone botpress

Because this is only a custom module, we first need to clone the botpress repository. We need the original repo for building the module.

$ git clone https://github.com/botpress/botpress.git
$ cd botpress

Clone bs-utility module

To build the custom module, please clone the repository into the ./modules/ directory from your existing botpress repo.

After cloning and run install all the mandatory files for buidling are loaded.

$ cd botpress/modules/
$ git clone https://github.com/whati001/bs-utility.git
$ cd bs-utility
$ yarn install

Build botpress

Now we are ready to build the entire botpress project which includes your custom module.

$ cd botpress/
$ yarn build
# fix missing rentencepiece.node

Watch the module

Because rebuilding the entire project would take to much time, we can just rebuild your module and reload botpress ui to test out your new changes. For this, please build ones the entire project like shown in Build the module. After building ones, we can link the modules into the build output by executing following commands. We recommend to use tmux for multi window support.

# link modules into botpress build output
$ cd botpress/
$ yarn cmd dev:modules

# window 1
# start botpress
$ yarn start

# window 2
# start watching your module for changes
$ cd botpress/modules/bs-utility/
$ yarn watch

Package the module

To generate a archive package just run:

$yarn package

Dockerfile

If you prefer, you can also use the crapy Dockerfile inside the docker/ directory. This will create a new container with botpress and bs-utility cloned and build ones. To enable rappildy development, please just mount your local bs-utility instance into the container and execute following commands inside.

# build docker container
$ docker build -t bp:custom - < docker/Dockerfile
# run docker container
$ docker run --rm -it -p 3000:3000 -p 3001:3001 -v /local/path/bs-utility:/botpress/modules/bs-utility bp:custom

# window 1
# start botpress
$ cd botpress/
$ yarn start

# window 2
# start watching your module for changes
$ cd botpress/modules/bs-utility/
$ yarn watch