Skip to content
Slack bot to help iFood orders
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
commands
config
data
node_modules
service
README.md
index.js
package.json
parse.js
util.js

README.md

Slack iFood Agent

A slackbot that helps groups of users to make orders from iFood on Slack. Made using node.js and slack-terminalize package.

How does it works?

In large groups of people working together, it may be hard to ask for food and keep track of every person in a chat. This slackbot helps to organize the order by providing a way that multiple persons make requests to a single iFood order on Slack, automatically calculating the price each one must pay.

When someone creates an order, an alert will pop on channel, and users can join using "order-join" command or use the "menu" command to check all the possible items. You can also add a shared request (shared for everyone) or a custom request (by adding the price instead of the desired item). Users can also give up on request or order when using specific commands.

By closing the order, all prices will be calculated automatically and all users will receive how much they must pay, while the order creator will have a list to what order on iFood.

Commands

As a slackbot, Slack iFood Agent needs to receive specific commands to work, as listed below:

  • help: Lists all available command;
  • menu [restaurant-id]: Lists the restaurants menu; Ex: menu nilo
  • order [restaurant-id]: Creates an order to a specific restaurant. You cannot create more than one order per user; Ex: order nilo
  • order-check [username]: Check the order status from an open order made by a specific username; Ex: order-check @mariotoledo
  • order-join [username] [item-id] [quantity] [obs (optional)]: Makes a request to an open order made by a specific username. You must provide an item id (the desired food you want) and a quantity. Also, you can pass some observation, if needed; Ex: order-join @mariotoledo carne 1 fechada
  • order-custom [username] [label] [price]: Creates a custom request without having to specify an item id. You must provide an item label and a price; Ex: order-custom @mariotoledo risoli 2.50
  • order-shared [username] [item-id] [quantity] [obs (optional)]: Creates a shared request to all users. The item price will be divided to all users when the order closes; Ex: order-shared @mariotoledo refrigerante-2l 1
  • order-unjoin [username] [item-id] [quantity]: Removes a request from an open order; Ex: order-unjoin @mariotoledo carne 1 fechada
  • order-delete: Removes an open order. You must be the order's creator to do that; _Ex: order-delete
  • set-delivery-price [price]: Specifies the delivery price; Ex: set-delivery-price 5.50
  • order-close: Closes the open order. All the items will be calculated and printed. You must be the order's creator to do that; _Ex: order-close

Installation

If you want to use Slack iFood Agent on your team's Slack, then you must configure a few things before:

  • Creates a Slack App: Go to https://.slack.com/services/new/bot, create a new bot and copy the API token
  • Add API token: Open index.js and replace the API token on int function:
var slackTerminal = require('slack-terminalize');

slackTerminal.init('PUT API TOKEN HERE', {
}, {
    CONFIG_DIR: __dirname + '/config',
    COMMAND_DIR: __dirname + '/commands'
});
  • Configuring restaurants and menus: All restaurants and menus must be configured in restaurants.json file. As iFood does not have an API, we made a parser as shown on parse.js.
  • Turning agent available for use: You can execute the agent on your computer (node index.js) or deploying it to an instance like Heroku.

Development

If you want to help in development, these is how the project is configured:

  • commands folder: all commands scripts must be included here. Each commands receives params as default, where you can receive parameters from Slack, as listed below: -- user: A string with the user id that used the command -- channel: A string the channel where the command was executed -- params: An array with all the params inserted after the command.
  • commands.json: a JSON file containing all the avaiable commands
  • restaurants.json: a JSON file containing all the available restaurants and menus
  • service folder: stores all services. All features must be implemented in suitable services, as orders_service or restaurants_service
  • util.js: contains helpers functions, as postMessage function
You can’t perform that action at this time.