fossasia/susi_fbbot

# AskSusi Facebook Messenger Bot

Development [![Build Status](https://travis-ci.org/fossasia/susi_fbbot.svg?branch=development)](https://travis-ci.org/fossasia/susi_fbbot)
Master [![Build Status](https://travis-ci.org/fossasia/susi_fbbot.svg?branch=master)](https://travis-ci.org/fossasia/susi_fbbot)
[![CircleCI](https://img.shields.io/circleci/project/fossasia/susi_fbbot.svg?maxAge=2592000?style=flat-square)](https://circleci.com/gh/fossasia/susi_fbbot)
[![Code Climate](https://codeclimate.com/github/fossasia/susi_fbbot/badges/gpa.svg)](https://codeclimate.com/github/fossasia/susi_fbbot)
[![Join the chat at https://gitter.im/fossasia/susi_server](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/fossasia/susi_server)

This is the  Facebook messenger bot for [AskSusi](https://www.m.me/asksusiai).

## Technology Stack

```node.js``` and ```Express```.

## Getting Started

It's easy for you to create your own facebook messenger bot and integrate susi's API into it. You can read the  [documentation](https://developers.facebook.com/docs/messenger-platform/quickstart) as prepared by the Messenger team.

Messenger bots uses a web server to process messages it receives or to figure out what messages to send. You also need to have the bot be authenticated to speak with the web server and the bot approved by Facebook to speak with the public.

### Setup your own Messenger Bot
1. Fork this repository.

2. Create a facebook page [here](https://www.facebook.com/pages/create/).

 ![Creating a FB Page](./docs/images/1_create_fb_page.png)

 ![New FB Page](./docs/images/2_fb_page.png)

3. Create a new [Google Cloud](docs/installations/gce-kubernetes.md) or [Heroku App](https://dashboard.heroku.com/new?org=personal-apps).

 ![New Heroku App](./docs/images/3_create_heroku_app.png)

4. Connect the heroku app to the forked repository.

 ![Connect to Github](./docs/images/4_heroku_github_connect.png)

5. Deploy on development branch. If you intend to contribute, it is recommended to Enable Automatic Deploys.

 ![Branch Deployment](./docs/images/5_branch_selection.png)

 ![Successful Deployment](./docs/images/6_heroku_deployment.png)

6. Create or configure a Facebook App or Page [here](https://developers.facebook.com/apps/)

 ![New FB App](./docs/images/7_create_fb_app.png)

7. Get started with Messenger tab in the created app.

 ![Messenger Selection](./docs/images/8_select_messenger.png)

8. In the Page Access Token select the fb page that you created and generate the token and save it somewhere for future use.

 ![Token Generation](./docs/images/9_select_token.png)

9. Now, go to the heroku app, select the settings tab and add the environment variable as shown, where key is FB_PAGE_ACCESS_TOKEN and value is the token generated in the previous step.

 ![Environment Variable](./docs/images/10_add_env_variable.png)

10. Create a webhook on the facebook app dashboard. The Callback url should be https://<your_app_name>.herokuapp.com/webhook/ and rest should be as shown in the image below.

 ![Webhook Creation](./docs/images/11_add_webhook.png)

 ![App Complete](./docs/images/12_app_complete.png)

11. Go to Terminal and type in this command to trigger the Facebook app to send messages. Remember to use the token you requested earlier.
  ```
  curl -X POST "https://graph.facebook.com/v2.6/me/subscribed_apps?access_token=<PAGE_ACCESS_TOKEN>"
  ```

12. Go to the facebook page created and locate 'Message Now' or go to https://m.me/PAGE_USERNAME

 ![Message on Page](./docs/images/13_message_on_page.png)

13. Enjoy chatting with Susi.

 ![Message on Page](./docs/images/14_fb_chat.png)


## Branch Policy

The default branch is ```development```, so make sure you contribute only on this branch.

## License

This project is licensed under the GNU GENERAL PUBLIC LICENSE, Version 3. Please find more info in our [license document](LICENSE.md).