To run the chatbot, then it is necessary to have Node installed on your system.

The project has only been tested on recent versions of Node, and hence it is recommened to use Node >= 8.0.

Furthermore typescript is required to compile the project to Node compatible JavaScript code.

To install TypeScript run the command npm install -g typescript or yarn global add typescript

The PolloPollo chat-bot project is written in TypeScript and hence compilation is required in order to run the project. Therefore, to run the bot, please use the following steps:

1. Run the command tsc in the root of the project
2. Run the command yarn start/npm run start to run the bot

In order to deploy to chat-bot to the server then please go through the following steps:

1. Run the command tscin the root of the project
2. Connect to the server and navigate to the headless-obyte folder
3. Upload all files in the project except the folder node_modules and conf.js
4. Run npm install on the server within the headless-obyte folder
5. Run the command npm run start to start the bot

The PolloPollo chat-bot is separated into two main functionalities.

The first part is functionality to respond to requests from Obyte wallets, and the second part is a listener that awaits requests on /bot/*. These requests are validated and will only be processed if they're interacted with from the PolloPollo backend.