https://github.com/nexmo-community/facebook-gif-chat
Facebook Messenger Animated Gif Search and Transform Chatbot
https://github.com/nexmo-community/facebook-gif-chat
cloudinary facebook-messenger-bot giphy-api nexmo rubyonrails
Last synced: 3 months ago
JSON representation
Facebook Messenger Animated Gif Search and Transform Chatbot
- Host: GitHub
- URL: https://github.com/nexmo-community/facebook-gif-chat
- Owner: nexmo-community
- License: mit
- Created: 2020-02-04T19:00:48.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-03-07T01:03:28.000Z (over 1 year ago)
- Last Synced: 2024-05-02T01:00:51.319Z (over 1 year ago)
- Topics: cloudinary, facebook-messenger-bot, giphy-api, nexmo, rubyonrails
- Language: Ruby
- Size: 2.45 MB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Facebook Messenger Animated Gif Search and Transform Chatbot
This repository contains the code for a working Facebook Messenger Chatbot that allows users to search for animated gifs and then apply instant image transformations to those gifs and receive back the transformed gif.
* [Prerequisites](#prerequisites)
* [Installation and Usage](#installation-and-usage)
* [Contributing](#contributing)
* [License](#license)
## Prerequisites
In order to use this application you need to have:
* [Ruby on Rails](https://rubyonrails.org/) installed locally
* [Nexmo Account](https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=facebook-gif-chat) and API Credentials
* [GIPHY Developer Account](https://developers.giphy.com/) and API credentials
* [Cloudinary Account](https://cloudinary.com/users/register/free) and API Credentials
* [Facebook](https://www.facebook.com)
## Installation and Usage
To install and use this application:
* Clone the repository
* Rename the `.env.sample` file to `.env`
* Fill in your API credentials in the `.env` file
* Run `bundle install` and `rake db:migrate` to initialize your Rails application
* Start your Rails server with `bundle exec rails start`
* Make sure your Rails server is externally available. ([Using ngrok](https://developer.nexmo.com/concepts/guides/testing-with-ngrok) is a great way to do that in development)
* Provide your externally available webhook status and inbound URLs (`#{YOUR_URL}/inbound` and `#{YOUR_URL}/status`) to your [Nexmo Application](https://dashboard.nexmo.com) set-up so you can receive incoming Facebook chat messages
* Link your Nexmo Application to your Facebook Page (See [this guide](https://developer.nexmo.com/messages/concepts/facebook) on how to do that)
* Search for an animated gif by sending a message to your linked Facebook page in the following format: `search #{item}`, i.e. `search hummus`
* Send a subsequent transformation request in the following message format: `transform #{transformation}`, i.e. `transform sepia`
## Contributing
We ❤️ contributions from everyone! [Bug reports](https://github.com/Nexmo-community/facebook-gif-chat/issues), [bug fixes](https://github.com/Nexmo/facebook-gif-chat/pulls) and feedback on the library is always appreciated. Look at the [Contributor Guidelines](https://github.com/Nexmo/facebook-gif-chat/blob/master/CONTRIBUTING.md) for more information and please follow the [GitHub Flow](https://guides.github.com/introduction/flow/index.html).
## License
This project is under the [MIT LICENSE](https://github.com/Nexmo/facebook-gif-chat/blob/master/LICENSE.txt).