xkcd for GroupMe Nodejs

by minhkhang1795

GitHub Readme.md

xkcd Bot for GroupMe written in NodeJS

Introduction

This project creates a bot that feeds xkcd comics to one specific GroupMe.

Contents

Requirements:

Get your bot up and running

Deploy to Heroku:

Be sure to log into heroku, using your heroku credentials, then click the link below.

Deploy

You should be taken to a page that looks like this:

Deploy to Heroku

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).

Success

Next, create a GroupMe Bot:

Go to: https://dev.groupme.com/session/new

Use your GroupMe credentials to log into the developer site.

Log into dev.groupme.com

Once you have successfully logged in, go to https://dev.groupme.com/bots/new

Create your new bot

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

Find your Bot ID:

Go here to view all of your bots: https://dev.groupme.com/bots

Click on the one you just created.

Select your new bot

On your Bot's page, copy the Bot ID

Copy your 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

Select your heroku app

On your app page, click settings in the top navigation:

Go to your app's settings

On your app's setting page, find the Config Vars section and click the Reveal Config Vars button:

Reveal your environment variables

Then click edit:

Edit your environment variables

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

Add the Bot ID environment variable

Now go test your bot!

Go to GroupMe and type "@xkcd hi" in the group where your bot lives to see it in action.

Test your Bot

Make it your own

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

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.