This is a Facebook Messenger chatbot template for restaurants. Restaurants can make use of this project by deploying it in their own servers to provide the Messenger chatbot based food ordering.
You can see this bot in action at this video
Using this bot the users can do the following,
- View the menu
- Add/remove food to cart
- View the receipt
- Track their order
Note: This chatbot is currently in development phase, So before start using this chatbot, you need to be in the testers list of this bot. Just send an E-mail to balaji030698@gmail.com with your Facebook profile URL, I will add you to the testers list. You will get an invite notification through Facebook. After accepting the invitation, You can start using this bot.
Once the chatbot is published, Every Facebook user can access it without requesting for the test user access.
The demo chatbot is currently deployed in the page https://www.facebook.com/Food2HomeBot
- Open the url https://m.me/Food2HomeBot.
- Click on the GET STARTED button to start the conversation.
- You can use the menu present in the chat to send messages quickly.
Since this bot using Natural Language Processing(NLP), The users can converse with the bot using their own phrases.
The sample phrases that users can use,
- Show me the menu
- Add five Pizzas to the cart
- Show me my cart
- Remove burger from cart
- Can you show me the menu?
- Place this order
- Show me the receipt
- What is the status of my order?
- Ruby
- MySQL Database
- Online hosting server
- Wit Project (For Natural Language Processing)
First, you'll need to fork and clone this repo
Open Terminal. Change the current working directory to the location where you want the cloned directory to be created.
git clone https://github.com/Balaji-Ramasubramanian/Food2Home
Let's get all our dependencies setup:
bundle install
You need to change the .env file with your appropriate access tokens, usernames, and passwords. You need to add the following details,
- Facebook page access token
- Verify token for your Facebook app
- App secret token
- Wit access token
- Database Host
- Database Name
- Database Username
- Database Password
First, you'll need to migrate the database tables
rake db:migrate
Download ngrok in your local system.
Open terminal and navigate to the project folder
run rackup -p <port_number>.
Open another window in terminal
run <path_of_ngrok_file> http <port_number>
copy the URL with 'https://' prefix. This is your webhook URL that serves your program.
You need to have Heroku CLI installed to deploy the bot in Heroku. To find more details about Heroku CLI, click here.
You can follow this link to setup the Heroku environment for the project.
For this project, you need the following resources in your Heroku project,
- ClearDB MySQL :: Database
- Heroku Scheduler
I will update the instructions for deploying the app in AWS, Google Cloud and Microsoft Azure shortly.
- Go to developers.facebook.com
- Login using your Facebook account username and password.
- Select 'Add New App' under 'My Apps' section.
- Give a suitable name for you bot and click submit.
- Click 'set up' in Messenger product. Within the Messenger product, Select the page you want to add this chatbot and setup webhook.
In developers.facebook.com, Navigate to your app's dashboard and click 'webhook' under products section. Click 'Edit subscription' button and Paste the Webhook URL over there.
Note Don't forget to append '/webhook' after the URL (since config.ru file mapped to the path '/webhook').
https://<YOUR_URL>>/webhook
Or you can modify your config.ru file in your project to map whatever URL path you want.
During the development phase, only the admins of the bot and the test users who are added by the admins are able to use the bot. Admins of the chatbot can add more Facebook users and also add test users through their app's dashboard.
To add new roles, Navigate to the app's dashboard on Facebook developer's page. Click on Roles -> Roles. In this page, we can add Facebook users to any one of the roles of admin/developer/tester/analytic user.
Test Users are temporary Facebook accounts that you can create to test various features of your app. To add test users for your app, Navigate to Roles -> Test Users and click on add/edit test user accounts.
To publish the chatbot, we need to submit our app for Facebook review. To do that, click on App Review -> start a submission.
After publishing the app, any Facebook users can access it by directly sending messages to the corresponding Facebook page that hosts the chatbot.
- Fork the project.
- Make required changes and commit.
- Generate a pull request. Mention all the required description regarding the changes you have made.
If you need any help in customizing and deploying this project, email me @ balaji030698@gmail.com
Copyright 2018 Balaji Ramasubramanian
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.