kosset / duty-bot

Duty bot is a greek FB Messenger chatbot created to serve the nearest open pharmacies of a specified location (in Greece).

Duty-Bot

A Greek FB Messenger chatbot created to serve the nearest pharmacies on duty for a specified location.
Explore the docs »

Chat with the bot · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

There are many times in our life that we are in need of a pharmacy in the middle of the night. That is why I created the Dutybot, it asks for a user's location and then it serves the nearest pharmacies that are on duty.

The project is separated in two Services, the Bot and the Web Scrapper-API. This repository implements the Bot service. The Web Scrapper-API will be uploaded later on github.

The Bot service connects the Communication Channels (at the momment FB Messenger) with an Natural Language Understanding platform (Wit.ai or Dialogflow) and the database (soon to be changed communication with the API directly) and serves to Users details about the Pharmacies.

Built With

• NodeJS
• MongoDB

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• NodeJS (at least v10.15.3)
• MongoDB (v4.0)
• Facebook Account

Installation

1. Clone the repo

git clone https:://github.com/kosset/duty-bot.git

2. Install NPM packages

npm install

3. Create Bot App in FB and add the credentials in the config file

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Your Name - @your_twitter - [email protected]

Project Link: https://github.com/your_username/repo_name

Acknowledgements

• GitHub Emoji Cheat Sheet
• Img Shields
• Choose an Open Source License
• GitHub Pages
• Animate.css
• Loaders.css
• Slick Carousel
• Smooth Scroll
• Sticky Kit
• JVectorMap
• Font Awesome