thornjad / jtbot

Automated Twitter bot
https://www.npmjs.com/package/jtbot
ISC License
2 stars 1 forks source link
heroku jade-bot javascript node node-js nodejs npm twitter twitter-api twitter-application twitter-bot

jtbot

Greenkeeper badge Build Status Known Vulnerabilities ISC License

jtbot is a Node-based Twitter bot which automates the process of retweeting tweets of interest.

This project was previously known as Jade-bot

Installation

Set up the bot

$ git clone https://github.com/Raindeer44/jtbot.git
$ cd jtbot/
$ npm
$ npm test

jtbot is available on npm:

npm install -g jtbot

Get API keys

Set up application keys for the Twitter account you want to use: https://apps.twitter.com/app/new. Create a file called .env (with the dot) and put these keys in it:

.env also needs the rate at which you want the bot to retweet (in minutes).

For example, .env might look something like

CONSUMER_KEY=Fw***********P9
CONSUMER_SECRET=TD************Cq
ACCESS_TOKEN=31**************UC
ACCESS_TOKEN_SECRET=r0************S2

TWITTER_RETWEET_RATE=30

Start the bot

That's all the set up! Now just run

$ npm start

For continuous usage, either run on a server (if you happen to have one lying around) or deploy to Heroku, a serverless architecture or a similar service.

Contributing

Please fork this repository and contribute back using pull requests.

Any contributions, large or small, major features, bug fixes and integration tests are welcomed and appreciated but will be thoroughly reviewed and discussed.

FAQ

Why doesn't jtbot favorite/like tweets anymore?

Unfortunately automated favorites/likes are no longer allowed by the Twitter TOS. As such, functionality has been removed.

Does my username need to go somewhere?

Nope! The Twitter application keys are linked to the account.

Links

This bot was created with the help of Spences10's Node.js Twitter bot bootstrap, and with inspiration from @amanhimself.