By Scott Spence
UPDATE 20171102: Since this story was originally posted back in January 2017 there have been a few things that have changed with the repository on GitHub, if you are going to be following along I’d suggest using the repository
[README.md](https://github.com/spences10/twitter-bot-bootstrap/#twitter-bot-bootstrap)in conjunction with this story to save any confusion.
Twitter bots can do a heck of a lot more than just spam trending hashtags and relentlessly follow users.
Take the Twisst ISS alerts bot, which sends you a direct message whenever the international space station (ISS) will be visible at your location.
Or public service bots like the Earthquake Robot, which tweets about any earthquake greater than 5.0 on the Richter Scale as it happens.
And of course a robot that tweets poetry, poem.exe, along with one that will retweet your tweets that also happen to be an Accidental Haiku.
I personally use a bot to enhance my @ScottDevTweets account by liking and re-tweeting subjects I have an interest in.
The #100DaysOfCode community challenge will congratulate you on starting the #100DaysOfCode challenge, and again when you reach specific milestones.
It will also reply with encouragement if it detects negative sentiment (frustration) in a tweet that has the #100DaysOfCode hashtag in it.
One question I’m asked in job interviews quite often is “what do you get out of working with technology?” I always answer that “I like to automate repetitive tasks to save me time so I can concentrate on other stuff. I like the the feeling of accomplishment that comes with having saved myself some time.”
In the case of my @ScottDevTweets bot, it’s usually an opener for a conversation with another person who follows me. So the bot can initiate the conversation, then I can carry on from where the bot left off.
Bearing this in mind, a bot is only as ethical as the person who programmed it.
If you have any doubts about the ethics of the bot you’re building, check out botwiki’s ethics section.
So, ready to get started? OK. Let’s do this!
How to build a Twitter Bot in 30 minutes
You’re going to use the twit library to build a Twitter bot. It will like and re-tweet whatever you specify. It will also reply to your followers with a selection of canned responses.
Before starting the clock you’ll need to set up some accounts set up if you don’t have them already.
What you’ll need
Step #1: Set up a Twitter application
Either create a new Twitter account or use your own to create a new Twitter application.
As an example, I’ll configure my old @DroidScott twitter account so you can follow along.
Be sure to add your phone number to your Twitter account before clicking the Create your Twitter application button.
You should now be in the ‘Application Management’ section, where you will need to take a note of your keys. You should have your ‘Consumer Key (API Key)’ and ‘Consumer Secret (API Secret)’ already available.
You’ll need to scroll to the bottom of the page and click the Create my access token to get the ‘Access Token’ and ‘Access Token Secret’ take note of all four of them you’ll need them when setting up the bot.
Step #2: Set up your development environment
For this I’m just going to say use Cloud9 as you can be up and running in minutes with one of the pre-made Node.js environments.
Note that if you choose to use Heroku and/or Cloud9 IDE in building this (like I do in this guide) in some regions you will be prompted to give a credit card number to create these accounts.
Set up the bot
In the project tree delete the example project files of client, package.json, README.md and server.js you’ll not need them, you can leave them there if you desire.
In your new Node.js c9 environment go to the terminal and enter:
git clone https://github.com/spences10/twitter-bot-bootstrap
Project structure
The environment project tree should look something like this:
Node dependencies
Before configuring the bot we’ll need to install the dependencies, cd into the project folder with cd tw* this will move you to :~/workspace/twitter-bot-bootstrap (master) $ from the terminal enter:
npm install
This will install all the dependencies listed in the package.json file.
If you get any errors then I suggest installing the dependencies one by one from the package.json file with the same command and the package name at the end:
Here is an example of the dependencies in the package,json file:
"dependencies": { "dotenv": "^4.0.0", "twit": "^2.2.5", "unique-random-array": "^1.0.0", "unirest": "^0.5.1" }
The npm command to install them all:
npm install --save dotenv twit unique-random-array unirest
If you get any WARN messages such as npm WARN package.json twitter-bot@1.0.0 No repository field this will not break the bot so it's safe to ignore.
Now you can configure the bot. From the terminal enter:
npm init
This will configure the package.json file with your details as desired. Just keep hitting return if you're happy with the defaults.
Now you’ll need to add your Twitter keys to the .env file. Just input the keys in their corresponding fields and save the file.
If you can not find the .env file in the file structure of your c9 project then you will need to enable the Show Hidden Filesoption. In the file view select the settings cog then tick the Show Hidden Files option if it is not already checked.
The SENTIMENT_KEY you can get a new API key at https://market.mashape.com/vivekn/sentiment-3 your key is in the REQUEST EXAMPLE
Take a look at the gif, click the link, sign up for or sign into mashape, click on node in the right hand panel and select out your API key, it will be in the space highlighted <required> in the gif.
Add your API key to the .env file along with your Twitter API keys ?
Here you should add your Twitter account name, and how often you want the bot to run the retweet and favorite functions in minutes.
NOTE none of the
.envitems have quotes''round them.
CONSUMER_KEY=Fw***********P9CONSUMER_SECRET=TD************CqACCESS_TOKEN=31**************UCACCESS_TOKEN_SECRET=r0************S2SENTIMENT_KEY=Gj************lFTWITTER_USERNAME=DroidScottTWITTER_RETWEET_RATE=5TWITTER_FAVORITE_RATE=5
You can then add some keywords into the strings.js file for what you want to search for as well as sub-queries.
When adding sub-query strings make sure you leave a space at the beginning of the string so ' handy tip' gets concatenated onto 'node.js' as node.js handy tip and not node.jshandy tip.
That should be it, go to the terminal and enter npm start you should get some output:
Check the Twitter account:
Step #3: Setting up Heroku
Cool, now we have a bot that we can test on our dev environment but we can’t leave it there, we’ll need to deploy it to Heroku.
If you haven’t done so already set up a Heroku account then select Create a new app from the dropdown box top right of your dashboard, in the next screen name the app it if you want, then click Create App.
You’ll be presented with your app dashboard and instructions for the deployment method.
Your app name should be displayed on the top of your dashboard, you’ll need this when logging in with the Heroku command line interface, which we’ll use to deploy your app.
Heroku CLI
We’re going to deploy initially via the Heroku Command Line Interface (CLI).
On your c9 environment terminal, log into Heroku [it should be installed by default]
heroku login
Enter your credentials:
cd twitter-bot-bootstrap git init heroku git:remote -a your-heroku-app-name
Deploy your application:
git add . git commit -am 'make it better' git push heroku master
You should get build output in the terminal:
Then check the output with:
heroku logs -t
All good? Cool! ?
Configuring Heroku variables
Now that we have our bot on Heroku we need to add environment variables to store our Twitter keys. This is because the .env file where we stored our keys is listed in the .gitignore file, which tells git not to upload that file to Heroku. It also makes it so if in the future we want to add our code to GitHub we don't have to worry about the .env file making our keys public, because the file will automatically be ignored.
All you need to do is go to the console of your Heroku app and select the ‘Settings’ sections and add in your Twitter keys from the .env file. Click the 'Reveal Config Vars' button and add in the variables with their corresponding values:
CONSUMER_KEYCONSUMER_SECRETACCESS_TOKENACCESS_TOKEN_SECRETSENTIMENT_KEY
Once you have the Heroku vars set up, take a look at the config.js file of this project. You are going to delete this line:
require('dotenv').config();
You’re now ready to deploy to Heroku again. Your console commands should look something like this:
$ git add .$ git commit -m 'add environment variables'$ git push heroku master
Then you can check the Heroku logs again with:
$ heroku logs -t
You should now have a bot you can leave to do its thing forever more, or until you decide you want to change the search criteria ?
Heroku deployment via GitHub
You can also deploy your app by connecting to GitHub and deploy automatically to Heroku each time your master branch is updated on GitHub, this is straight forward enough.
Go to the ‘Deploy’ dashboard on Heroku, select GitHub as the deployment method if you have connected your GitHub account to your Heroku account then you can search for the repository so if you forked this repo then you can just enter twitter-bot-bootstrap and Search you can then click the Connect button, you can then auto deploy from GitHub.
Heroku troubleshooting
What do you mean it crashed!?
Ok, I found that sometimes the worker is set as web and it crashes out, try setting the worker again with:
heroku ps:scale worker=0 heroku ps:scale worker=1
If that still crashes out then try setting the Resources on the Heroku dashboard, I found if you toggle between the web, heroku and worker it usually settles down. Basically you need to be set to the worker Dyno this is what causes the Error R10 (Boot timeout) crashes because it's trying to use one of the other resources when it should be using the worker Dyno.
Other useful Heroku commands I use:
heroku restart
By default you can only push your master branch if you are working on a development branch i.e. dev branch. If you want to test on Heroku, then you can use:
git push heroku dev:master
Handy tip
If you want to add this to your own GitHub repo and don’t want to share your API keys ? with the world then you should turn off tracking on the .env file. From the terminal enter this git command:
$ git update-index --assume-unchanged .env
I have added my most used git command I use in this gist
Wrapping up
Your Twitter bot should now be live. You can tinker with it and further configure it.
Here’s my repository if you’d like to fork it and contribute back using pull requests. Any contributions large or small — major features, bug-fixes, integration tests — are welcome, but will be thoroughly reviewed and discussed.
Acknowledgements
Credit for the inspiration for this should go to @amanhimself and his posts on creating your own twitter bot.
create-a-simple-twitter-bot-with-node-js
how-to-make-a-twitter-bot-with-nodejs
Other posts detailing useful Twitter bots.
www.brit.co/twitter-bots-to-follow
www.hongkiat.com/using-twitter-bots
Made it this far? Wow, thanks for reading! If you liked this story, please don’t forget to recommend it by clicking the ❤ button on the side, and by sharing it with your friends through social media.
If you want to learn more about me, visit my blog, my Github, or tweet me @ScottDevTweets.
You can read other articles like this on my blog.