https://github.com/nexmo-community/facebook-banner-generator
Facebook Messenger Chatbot that allows users to create banner images with custom text and randomly selected colors
https://github.com/nexmo-community/facebook-banner-generator
facebook facebook-messenger-bot nexmo rails ruby ruby-on-rails sidekiq vonage
Last synced: 2 months ago
JSON representation
Facebook Messenger Chatbot that allows users to create banner images with custom text and randomly selected colors
- Host: GitHub
- URL: https://github.com/nexmo-community/facebook-banner-generator
- Owner: nexmo-community
- License: mit
- Created: 2020-08-06T11:03:12.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-03-27T06:23:41.000Z (over 1 year ago)
- Last Synced: 2025-04-05T01:25:28.383Z (over 1 year ago)
- Topics: facebook, facebook-messenger-bot, nexmo, rails, ruby, ruby-on-rails, sidekiq, vonage
- Language: Ruby
- Homepage:
- Size: 473 KB
- Stars: 0
- Watchers: 9
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Facebook Messenger Banner Generator Chatbot
[](CODE_OF_CONDUCT.md)
[](./LICENSE.txt)
This repository contains the code for a working Facebook Messenger Chatbot that allows users to create banner images with custom text and randomly selected colors.
* [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/)
* [Sidekiq](https://sidekiq.org/)
* [Vonage API Account](https://dashboard.nexmo.com/sign-up?utm_source=DEV_REL&utm_medium=github&utm_campaign=facebook-banner-generator)
* [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 Nexmo/Vonage application ID in the `.env` file
* Fill in your Facebook page ID in the `.env` file
* After creating your Nexmo/Vonage application, make sure to save the `private.key` file in the root folder of your application. **Don't commit it to GitHub.**
* Run `bundle install` and `rake db:migrate` to initialize your Rails application
* Make sure `Spring` is disabled, you can do that by adding the environment variable when starting the server as seen in the next step
* Start your Rails server with `DISABLE_SPRING=true bundle exec rails start`
* Start Sidekiq separately with `DISABLE_SPRING=true bundle exec sidekiq`
* 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}/webhooks/message` and `#{YOUR_URL}/webhooks.status`) to your [Nexmo Application](https://dashboard.nexmo.com) 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)
* Send a message to your Facebook page and the bot will direct you from there
## Contributing
We ❤️ contributions from everyone! [Bug reports](https://github.com/Nexmo-community/facebook-banner-generator/issues), [bug fixes](https://github.com/Nexmo/facebook-banner-generator/pulls) and feedback on the library is always appreciated. Look at the [Contributor Guidelines](https://github.com/Nexmo/facebook-banner-generator/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-banner-generator/blob/master/LICENSE.txt).