Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.06 KB

README.md

File metadata and controls

34 lines (26 loc) · 1.06 KB
Raw

VegAssist

Twitter Bot that retweets people looking for support going vegan

VegAssist tracks usage of the term "vegan" on twitter's public stream, and processes each item, looking for exact matches on an array of preset phrases. If there's a match, the bot will retweet.

Installing

  1. Clone this repository
  2. Install node.js and npm
  3. Run npm install in the directory that you cloned this repository into
  4. Create a settings.js file with the format below, filling in your Twitter API credentials and Twitter botname:
  5. Run node .

settings.js format:

module.exports = {
  CREDS: {
    consumer_key:         '...',
    consumer_secret:      '...',
    access_token:         '...',
    access_token_secret:  '...'
  },
  FILTERS: [],
  HANDLE: 'botname'
}

Running the tests

Simply run npm test

Disabling retweets

Retweets can be disabled for testing purposes by using the argument --dry-run, e.g. node vegassist.js --dry-run. In dry run mode, matching tweets will be logged to the console but not retweeted.