https://github.com/itsabdessalam/twitter-unfollowers-bot

🤖 A Node.js bot that sends emails to notifies you about twitter unfollowers
https://github.com/itsabdessalam/twitter-unfollowers-bot

bot twitter twitter-api twitter-bot unfollowers

Last synced: 2 days ago
JSON representation

🤖 A Node.js bot that sends emails to notifies you about twitter unfollowers

• Host: GitHub
• URL: https://github.com/itsabdessalam/twitter-unfollowers-bot
• Owner: itsabdessalam
• Created: 2019-05-01T04:30:14.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-03T08:13:46.000Z (almost 2 years ago)
• Last Synced: 2023-03-07T14:15:07.621Z (over 1 year ago)
• Topics: bot, twitter, twitter-api, twitter-bot, unfollowers
• Language: JavaScript
• Homepage:
• Size: 343 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 🤖 Twitter unfollowers bot

> A Node.js bot that sends emails to notifies you about twitter unfollowers.

## Installation

You need to create a [Twitter app](https://developer.twitter.com/en/apps) to use the API.

### Requirements

This  project should be working as expected with the following minimal version of:

| Dependency |   Version   |

| ---------- | :---------: |

| node       | >= v10.15.0 |

| npm        |  >= v6.4.1  |

| nodemailer |  >= v6.1.1  |

| twit       | >= v2.2.11  |

### Getting started

```bash

# cloning git repository into `my-twitter-unfollowers-bot` folder

git clone https://github.com/Abdessalam98/twitter-unfollowers-bot my-twitter-unfollowers-bot

# install project dependencies

cd my-twitter-unfollowers-bot && my-twitter-unfollowers-bot

# run the project on your server

npm run start

```

### Settings

```javascript

config = {

    twitter: {

        app: {

            consumer_key: process.env.TWITTER_CONSUMER_KEY,

            consumer_secret: process.env.TWITTER_CONSUMER_SECRET,

            access_token: process.env.TWITTER_ACCESS_TOKEN_KEY,

            access_token_secret: process.env.TWITTER_ACCESS_TOKEN_SECRET

        },

        user_id: process.env.TWITTER_USER_ID,

        screen_name: process.env.TWITTER_SCREEN_NAME

    },

    mailer: {

        default_mail_config: {

            host: process.env.MAILER_HOST,

            port: process.env.MAILER_PORT,

            secure: process.env.MAILER_SECURE,

            auth: {

                user: process.env.MAILER_USER,

                pass: process.env.MAILER_USER_PASS

            }

        },

        sg_mail_Config: {

            auth: {

                api_user: process.env.SENDGRID_USERNAME,

                api_key: process.env.SENDGRID_PASSWORD

            }

        }

    },

    mail_sender: process.env.MAIL_SENDER,

    mail_receiver: process.env.MAIL_RECEIVER,

    website_url: process.env.WEBSITE_URL,

    interval_time: 15 // in minutes

}

```

## Author

[Abdessalam Benharira](https://github.com/abdessalamb98)