Giter Site home page Giter Site logo

lunchbuddy-bot's Introduction

Lunchbuddy

Lunchbuddy is a Slack bot providing daily lunch menus for configured restaurants.

Configuration

To make Lunchbuddy work, you need to edit the config.json file. It contains 3 configuration items.

token - bot token that you get when creating the bot in Slack
name - the name of the Slack bot
zomato_key - Zomato API key

No need to get and configure the Zomato API key when yo do not want to use this service.

Installation

Lunchbuddy is a regular Node.js app (although it does not use left-pad :), so just do npm install and npm start and the bot will start and connect to Slack (if configured properly).

Usage

You can invoke Lunchbuddy by mentioning him in any channel you invite it to or you can write it direct messages. It responds to help and shows you all the restuarants it is configured to fetch the menu for.

Asking Lunchbuddy for help

If you write to Lunchbuddy a name of a configured restaurant, it will respond with the daily lunch menu for this restaurant.

Showing daily menu

Getting started

Lunchbuddy contains a few restaurants and delivery services to get you started and show you how to use Zomato API, how to scrape web (Avion58, Motoburger) or how to parse JSON data (Ordr.cz).

Adding a new restaurant

The easiest way to add a new restaurant is to add a restaurant available in Zomato. You just need to add a new item to the zomato.json config

{
  "restaurants": [{
    "id": 16507044,
    "name": "GURMET",
    "keyword": "gurmet"
  }]
}

If you want to add a custom restaurant, take a look at the custom.js module to see samples of scraping web to get the daily lunch menu.

lunchbuddy-bot's People

Contributors

igorkulman avatar

Watchers

Robert Japełski avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.