Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/minhkhang1795/xkcdbot
A bot in NodeJs feeding xkcd comics to a GroupMe conversation
https://github.com/minhkhang1795/xkcdbot
groupme-bot nodejs xkcd-comics
Last synced: about 1 month ago
JSON representation
A bot in NodeJs feeding xkcd comics to a GroupMe conversation
- Host: GitHub
- URL: https://github.com/minhkhang1795/xkcdbot
- Owner: minhkhang1795
- License: mit
- Created: 2017-08-03T11:03:11.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-07T04:35:40.000Z (about 2 years ago)
- Last Synced: 2023-03-03T11:25:19.373Z (almost 2 years ago)
- Topics: groupme-bot, nodejs, xkcd-comics
- Language: JavaScript
- Homepage:
- Size: 1.36 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xkcd Bot for GroupMe written in NodeJS
## Introduction
This project creates a bot that feeds xkcd comics to one specific GroupMe.
## Contents
* [Quickly get our sample bot up and running in your groups](#deploy)
* Deploy the code to heroku
* Create a bot
* Configure to your bot's credentials
* [Make changes to the bot](#pull)
* Pull the code down to your local machine
* Bot Commands & Features
## Requirements:
* GroupMe account
* Heroku account
* [Heroku Toolbelt](https://toolbelt.heroku.com/)
## Deploy to Heroku:
Be sure to log into heroku, using your heroku credentials, then click the link below.
[](https://heroku.com/deploy)
You should be taken to a page that looks like this:
Optionally, you can give your app a name, or instead leave
it blank and let Heroku name it for you (you can change it later).
## Next, create a GroupMe Bot:
Go to:
https://dev.groupme.com/session/new
Use your GroupMe credentials to log into the developer site.
Once you have successfully logged in, go to https://dev.groupme.com/bots/new
Fill out the form to create your new bot:
* Select the group where you want the bot to live
* Give your bot a name
* Paste in the url to your newly deply heroku app
* `http://your-app-name-here.herokuapp.com/`
* (Optional) Give your bot an avatar by providing a url to an image
* Click submit
Go here to view all of your bots:
https://dev.groupme.com/bots
Click on the one you just created.
On your Bot's page, copy the Bot ID
## Add your Bot ID to your Heroku app:
Go here to see all of your Heroku apps and select the one you just created before:
https://dashboard-next.heroku.com/apps
On your app page, click settings in the top navigation:
On your app's setting page, find the Config Vars section and click the Reveal Config Vars button:
Then click edit:
Fill out the form to add an environment variable to your app:
* In the "key" field type: BOT_ID
* In the "value" field paste your Bot ID that you copied in the previous steps
* Click the save button
## Now go test your bot!
Go to GroupMe and type **"@xkcd hi"** in the group where your bot lives to see it in action.
## Pull the code to your local machine
Within terminal, change directory to the location where you would like the files to live, then run this command:
$ heroku git:clone -a YOUR_APP_NAME_HERE
And then change directory into the new folder
$ cd YOUR_APP_NAME_HERE
## After making changes, commit the code to heroku
$ git add .
$ git commit -m "Your Commit Message"
$ git push heroku master
Then go and check your bot.
# All done! Go play around and make the bot your own.
## Bot Commands & Features
* @xkcd hi - show test message/greeting
* @xkcd help - show a list of commands
* @xkcd newest/latest/current - show the newest comic
* @xkcd random - show a random comic
* @xkcd [NUMBER] - show comic [NUMBER]
* Beside the commands above, you can set up your bot to feed the newest comic to your group in Heroku Scheduler. The code associated with Heroku Scheduler is in `./bin/scheduler`.
You can freely edit your bot in `bot.js` file.
# Note
* This github was cloned from the original [GroupMe Bot Tutorial](https://github.com/groupme/bot-tutorial-nodejs)
* The project uses [Heroku Scheduler](https://elements.heroku.com/addons/scheduler) and [Heroku Redis](https://elements.heroku.com/addons/heroku-redis), which requires Credit Card Validation. Charges may apply if your usages exceed free limits.
# MIT License
Copyright 2017 MINH-KHANG VU
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.