iandeboisblanc / hipmunk-chatbot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Hipmunk Chatbot Engine

This is a node-based chatbot webserver built to interact with the Hipmunk Lessenger UI. Currently, it is capable of responding to simple weather prompts (e.g. "What is the weather in Arizona?") by utilizing the Google Maps and Dark Sky APIS.

To use, follow the setup instructions below to start the server, then visit the Lessenger UI and begin chatting!

Setup Instructions

Install Dependencies

1. Install Node

The chatbot requires at least Node v7, though Node v8 is recommended. You can download and install Node here, or manage multiple versions using NVM.

3. Install packages

yarn install

Setup Config

The chatbot requires API keys for Google Maps and Dark Sky. These need to be set in config.json. An example of the required config file has been provided as config.example.json. To generate the real config file, navigate to the project's root directory and run:

cp config.example.json config.json

Then update config.json to include your API keys.

Start Server

yarn start

NOTE: In order to interact with the Lessenger UI, the webserver is expected to run on localhost:9000.

During development, it may be useful to run the process using nodemon instead. To run with nodemon, install nodemon then use the command:

yarn run start-dev

About


Languages

Language:JavaScript 87.7%Language:HTML 8.8%Language:CSS 3.5%