After you have the necessary requirements, run the following commands:

git clone https://github.com/ericksonl/BirdWatcher.git
cd BirdWatcher
npm install

After installation finishes, follow configuration instructions. Run node . to start the bot.

⚙️ Configuration

Create a .env file in the project root following this outline:

⚠️ Never commit or share your token or api keys publicly ⚠️

DISCORD_TOKEN=<Discord Token>
CLIENT_ID=<Discord Client ID>

TWITTER_BEARER_TOKEN=<Twitter Bearer token>

DATABASE_TOKEN=<MongoDB Connection String>

🕒 Changing the update times

Locate line 64 in bot.js. Change the cron_value to your desired update times. Cron values are written in the following format:

Examples:

cron_value = 5 * * * * //this will output every 5 minutes
cron_value = 0 5 * * * //this will output everyday at 5am
cron_value = 0 5 4 * * //this will output on the 4th of every month at 5am
cron_value = 0 5 4 5 * //this will output on the 4th of May at 5am

For additional help and info on cron values see their official website

❗ Important Info

• Twitter has a rate limit of 15 requests per 15 minutes, and will return a max of 1000 followers per each request. This means you will be unable to track a user who has more than 15,000 followers. As a safegaurd, I capped BirdWatcher at 10,000. As stated above, Twitter now has paid tiers. BirdWatcher requires AT LEAST a "Basic Tier," costing a whopping 100$ a month. This tier has a rate limit of 100 requests per 24 hours per user, and 500 requests per 24 hours per app. Each request will return a max of 1000 followers per each request.