WE-HUB bot

Code for the chatbot we're working on

Table of contents

• Requirements
• Built with
• Set Up
  • Get and activate a sandbox
  • Create an Ngrok account
  • Setting up javascript server
  • Setting up the python server
• Customisation
• How to Use
  • Start Ngrok
  • Add your link to your twilio console
  • Run Python
  • Run JavaScript

Requirements

Before proceeding, you should install;

• Python 3.10.6
• Node JS 14 and above - download
• A reverse proxy agent. Preferably Ngrok
• A twilio sandbox - register for one here
• MongoDB - Cloud or MongoDB Compass

Built with

• Python
• Javacript

Set Up

Get a Sandbox

To do this, Create an account here and complete the process. After that, you go to your console > Messaging > settings > Whatsapp Sandbox Settings and follow the instructions you see there

Ngrok account

Create an Ngrok account and download the software here

JS Set-Up

Note: To do this, you should have NodeJS installed

In your Terminal

• Navigate to the folder in your terminal;

    cd ./node-backend_bot

• Install necessary packages by running;

    npm install

Py Set-Up

Note: To do this, you should have Python and the pipenv python package installed

In your Terminal

• Navigate to the folder in your terminal;

    cd ./python_bot

• If you do not have pipenv, install it by running;

    pip install pipenv

• Install necessary packages by running;

    pipenv sync

Customisation

Individual READMEs will be provided in the individual folders

• For Javascript
• For Python

How to use

Start Ngrok

• In the ngrok terminal, run;

    ngrok http 5000

Adding link to twilio console

Very Important

• Copy the tunnel link gotten from the ngrok terminal

• Update the link in your sandbox settings

• Click save at the bottom of the page to save your settings*

Run JS

In your Terminal

• Navigate to the folder in your terminal;

    cd ./node-backend_bot

• start the application

    npm run server

Run Python

In your Terminal

    cd ./python_bot

• Activate the Environment

    pipenv shell

• In the Virtual Environment, Run the program

    python main.py