5M5V Bot

Fork from plorry/VegAssist to retweet people looking for support going vegan for 5 Minutes 5 Vegans. https://5minutes5vegans.org

This bot tracks usage of the term "vegan" - and its translated variants depending on the config - on Twitter's public stream, and processes each item, looking for exact matches on an array of preset phrases. This bot can be setup for multiple authorised accounts for the same app, retweeting messages matching only certain filters to only certain accounts.

Installing

Yarn

1. Run yarn add 5m5v-bot to install the bot to your project
2. Copy the 5m5v-config.example.yaml file in node_modules/5m5v-bot into your own project under 5m5v-config.yaml and configure the bot
3. Run yarn 5m5v-bot in the directory of your project to run the bot

You can install the bot globally to your system with yarn global add 5m5v-bot instead. From then you can run yarn 5m5v-bot from any folder, as long as it contains a config file.

Manual

1. Clone this repository
2. Run yarn install in the directory that you cloned this repository into
3. Copy the 5m5v-config.example.yaml file to your own 5m5v-config.yaml and configure the bot
4. Run node . in the directory of the repository to run the bot

Configuration

The configuration is loaded from the .env file in the root of the project. The following keys are required:

TWEETS_API_ENDPOINT

The endpoint of the 5M5V API that will receive the tweets.

TWEETS_API_KEY

The API key of the 5M5V API that will receive the tweets.

TWITTER_EMAIL

The email address of the Twitter account that the bot will use to stream tweets.

TWITTER_USERNAME

The username of the Twitter account that the bot will use to stream tweets.

TWITTER_PASSWORD

The password of the Twitter account that the bot will use to stream tweets.

Running the tests

Simply run yarn test

Disabling retweets

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