README.md

ETF Bot

Student Service chatbot

Student service chatbot, where students can ask about various information and dashboard for controling the bot.

Getting Started

To get the code run next command:

$ git clone https://github.com/lazav94/ETF-Bot.git

Prerequisites

To run this code you need to have:

• Node.js
• Visual Studio Code - or other

Installing

You need to create an Facebook page and app and then to create .env file in the root. And you can see if you search through the project what enviroment variables do you need.

If you don't have nodemon you can install it with next command:

$ sudo npm i -g nodemon

To run the code you can do it with next commands:

$ nodemon
or
$ npm start

End with an example of getting some data out of the system or using it for a little demo

Running the tests

You can write you mocha tests. And run it:

npm run test

Technologies

• Backend: Node.js
• Frontend:
  • HTML (Pug or Jade)
  • CSS (Bootstrap)
  • JavaScript (JQuery)
• Database:
  • Mongo DB (non relational database)
• Bot: Facebook graph API
• NLP: DialogFlow (api.ai)

Links

• Bot
• Dashboard
• Demo video - bot
• Demo video - dashboard

Authors

• Lazar Vasic - lazav94

TODO

Notes

• This is only basic bot. There is a lot to do and this bot can be improved.
• If you have any suggestion please let me know, thank you.