/Github-Auto-Follower-Bot

A GitHub bot that automatically follows random users on GitHub. The bot is built using Node.js and the Octokit library to interact with the GitHub API.

Primary LanguageJavaScriptMIT LicenseMIT

GitHub Auto Follower Bot

This project is a GitHub bot that automatically follows random users on GitHub. The bot is built using Node.js and the Octokit library to interact with the GitHub API.

Getting Started

1. Clone the repo

git clone https://github.com/mrahmadhassankhan/Github-Auto-Follower-Bot/

2. Install Dependencies

npm install

3. Generate a Github Token and make sure your GitHub token has the user:follow scope to allow the bot to follow users on your behalf.

Visit https://github.com/settings/tokens to generate

4. Configure Environment Variables

Create a .env file in the root of the project and add your GitHub token:

GITHUB_TOKEN=your_github_token_here

3. Run the Bot

node bot.js

Usage

The bot will fetch a list of random users from GitHub and follow them with a delay between each follow to avoid hitting rate limits. The delay is set to 10 sec by default.

Contributing

We welcome contributions to this project! To get started:

  1. Fork the Repository

    • Click the "Fork" button at the top right of this repository to create your own copy.

  2. Clone Your Fork

    • Clone your forked repository to your local machine: 
      git clone https://github.com/mrahmadhassankhan/Github-Auto-Follower-Bot/

  3. Create a New Branch

    • Create a new branch for your feature or fix: 
      git checkout -b your-branch-name

  4. Make Your Changes

    • Implement your changes or new features.

  5. Test Your Changes

    • Ensure that your changes work as expected and do not break existing functionality.

  6. Commit Your Changes

    • Commit your changes with a clear and concise message: 
      git add .
git commit -m "Description of your changes"

  7. Push Your Changes

    • Push your changes to your forked repository: 
      git push origin your-branch-name

  8. Open a Pull Request

    • Go to the original repository and open a pull request from your forked repository.

Note

  • Make sure your GitHub token has the user:follow scope to allow the bot to follow users on your behalf.
  • Be mindful of GitHub's rate limits and terms of service when using this bot.

Dependencies

  • @octokit/rest: GitHub REST API client for Node.js
  • dotenv: Loads environment variables from a .env file

License

This project is licensed under the MIT License.