GroupMe Bot Starter

Starter code for the GroupMe bot workshop at ACM@UC

Before You Begin

You'll need a few things before you start:

Git
- Windows: install with git-scm.com
- OS X: install with git-scm.com or brew
- Run git --version to verify that Git is installed
Node.js >=4.0.0
- Windows: install with nodejs.org or nvm-windows
- OS X: install with nodejs.org, nvm, or brew
- Run node --version to see your Node.js version and verify that it is installed
A GroupMe account

Quick Tour

├─┬ lib
│ ├── bot.js - handles bot logic
│ ├── dev.js - creates a proxy server (for local development)
│ └── server.js - handles GET and POST requests to the app
├── screenshots - various ui screenshots
├── .editorconfig
├── .env.example - a template for the `.env` file
├── .gitignore
├── app.js - the app entry point
├── LICENSE.txt
├── package.json - project info and dependencies
├── Procfile - deployment configuration (for Heroku and similar deployment platforms)
└── README.md

Quick Start

0. Start a new GroupMe group

Launch the GroupMe app (or use web.groupme.com) and create a new group (or use an existing group)

1. Register a new GroupMe Bot

Head over to dev.groupme.com and login with your GroupMe credentials
Go to the bots tab and select Create Bot
Choose a group, and avatar uri for the bot. The callback url should be http://localhost:3000 for now
Select Submit to create your bot
Select your bot from the list of bots and save the bot id for later
Check the group that you added the bot to. There should be a message in chat that your bot was added to the group
Optional step: use the 'Test Your Bot' form (or use the provided curl command) on the newly created bot page to send a message to chat! This is an easy way to see how the bot interacts with GroupMe

2. Setup The Bot

Let's get this bot running on localhost!

Verify Node.js is installed by running node -v
Clone this repository with git clone https://github.com/acmatuc/groupme-bot-starter.git
cd groupme-bot-starter
Install dependencies with npm install
Setup a .env for storing your GroupMe bot id
- Copy .env.example to .env with cp .env.example .env
- Put your bot id in the key field for the value BOT_ID and save

3. Starting The Server

Making sure everything is setup correctly
- Run npm start and head over to http://localhost:3000 in your favorite web browser. This is a GET request, so the app will respond with Bot is responding to a GET request... hey there!
- This is great! The web server is working, but GroupMe sends POST requests to your app, so lets see if that is working
- Use ^C (control + C) to exit the program
Responding to a GroupMe message
- Run npm start (or npm run dev on development - see the note below)
- Launch GroupMe and open the group that the bot is registered in
- Post a message in the chat. By default the bot is setup to respond to messages starting with /shrug, so do that
- You should see that the bot responds with ¯\_(ツ)_/¯

Note: Running on your local machine

You'll notice that on your local development machine, you run npm run dev instead of npm start. In step 1 of this guide, you were told to set the bot url in GroupMe to http://localhost:3000. However, this setup will not work on your local development machine. The catch is that an external, api, such as GroupMe, cannot send a http request to localhost. The workaround: use a temporary proxy as a callback url while developing.

npm run dev will ask to expose port 3000 (your bot) to localtunnel.me - a very handy tool for web development. Localtunnel hands you a publicly accessible url that proxies to your local machine on a specified port. Don't like localtunnel? There are alternatives out there!

The localtunnel setup in this project will look at the LT_SUBDOMAIN environment variable to set a subdomain. If the environment variable is not set, localtunnel will choose a random subdomain. Use this domain as your GroupMe bot callback url. So if you were to set LT_SUBDOMAIN="myawesomecallbackurl" in your .env, then your GroupMe callback url would be http://myawesomecallbackurl.localtunnel.me

4. Customizing Your Bot

Use ^C to exit the program
Open lib/bot.js in your favorite text editor and play around. Don't forget to run npm start or npm run dev after you make a change!

Deploying to the Interwebz

Sure the bot works fine, but it is running on your local machine. Let's get the bot running on a live server for a 24/7 bot! Here are a few options to consider for deployment:

Note: be sure to set your BOT_ID in the .env (or equivalent configuration) and update the bot callback url in GroupMe to be that of your server for deployment!

Deploying to Heroku

Heroku is a nice option because of its PaaS 'push and forget' style of deployment. Heroku has a limited free tier that is great for deploying chat bots (the paid tier isn't too bad). Follow these steps to get your machine setup with Heroku and deploy your chat bot. Heroku even lets you easily set environment variables within their dashbaord or command line interface. This is super useful for setting a bot id configuration variable on Heroku.

Deploying to dokku

Dokku is another great option because its open source! Similar to Heroku, dokku allows you to 'push and forget', but the setup for dokku is more involved as it requires you to setup your own cloud server and install dokku before you can deploy. See this guide for deploying to dokku. Like Heroku, dokku allows you to easily set environment variables like your bot id.

Deploying to a cloud server

Heroku and dokku are great options for deployment of your chat bot, but you can simply spin up a small cloud server and run your chat bot with little setup. Some great, inexpensive cloud providers include DigitalOcean, Amazon AWS, Microsoft Azure, Linode, Rackspace, and more! Setting up, deploying, and maintaining your app on your own cloud server is more involved than a Heroku or dokku setup, but it does allow for more customization.

After spinning up a linux box, you would:

Install Node.js
Install a process manager like forever to run your chat bot in the background
git clone your chat bot to the server
Start the chat bot with the process manager

To update your bot:

Stop the chat bot with the process manager
git pull the latest chat bot changes
Start the chat bot with the process manager

Beyond This Guide

Check out dev.groupme.com for more information on GroupMe's api. The possibilities are endless when it comes to chat bots. These bots interact with simple http requests, so you can build them in the language or platform of your choice.

License

GNU GPLv3 License

Some content based on groupme/bot-tutorial-nodejs (MIT License)

dillnorm / groupme-bot-starter Goto Github PK