Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.56 KB

README.md

File metadata and controls

51 lines (38 loc) · 2.56 KB

OVH Chatbot Cover

OVH Chatbot - Node.js Gitter

The main goal of this tool is to help OVH clients in order to have faster responses when you have some problems with OVH services. For example for web hosting you can ask why your website is broken and then this chatbot will find a solution to fix that.

Setup

Visit INSTALL.md to setup and test on Slack or Facebook.

Webhooks for Facebook

This project handles callbacks for authentication, messages, delivery confirmation and postbacks. More details are available at the Facebook Documentations.

Webhooks for Slack

This project handles callbacks for authentication, messages. More details are available at the Slack Documentations.

Project overview

  • bots --> Represent all the modules about the bot's answers and it's specific type with an intention already given.
  • config --> The configuration of tools and configuration variables are in this directory.
  • constants --> Represents the constants of the project.
  • controllers --> The controllers contain handler function of an express route.
  • diagnostics --> Contains all the modules for the diagnostics.
  • models --> Contains database models.
  • providers --> Tools used globally in all the project.
  • routes --> Route declarations of the API.
  • platforms --> Contains all the handlers to communicate with different platforms.
  • utils --> Contains all the utilities and API connector to make this chatbot works.
  • views --> Not written yet.

To Add a New Platform: Visit this page.

To Add a New Intent or Response: Visit this page.

To Add a New Diagnostic:

  • At the moment only diagnostics for hosting are made but in order to create a new kind of diagnostic you have to create new file in diagnostics.

  • This file must export object with methods to make diagnostics

Contributing

Go on Contributing section and if you have any question come on our Gitter to discuss about it.

Roadmap

  • Refactor
  • Docker compose
  • Documentation
  • Translations
  • When will my service expire?
  • Monitoring
  • Alerting

License - 3-Clause BSD

See the LICENSE file in the root directory of this source tree. Feel free to use and modify the code.