Skip to content

Commit aa08a2e

Browse files
Merge remote-tracking branch 'refs/remotes/origin/main'
2 parents 420a759 + 5eb22e3 commit aa08a2e

File tree

1 file changed

+72
-2
lines changed

1 file changed

+72
-2
lines changed

README.md

+72-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,72 @@
1-
# Github-Auto-Followers-Bot
2-
A async Github program that automatically follows and unfollows users, to generate/boost your profile growth, presence, and interactions.
1+
<div align="center">
2+
<h1>
3+
Github-Followers-Bot
4+
</h1>
5+
</div>
6+
<p align="center">
7+
A Github Bot that automatically follows and unfollows users, to boost your profile growth, presence, and interactions.
8+
</p>
9+
10+
<div align="center">
11+
<img src="https://img.shields.io/badge/maintenance-experimental-blue.svg" alt="Maintained status" />
12+
<img src="https://img.shields.io/github/v/release/KevinTrinh1227/Github-Followers-Bot.svg" alt="Release badge" />
13+
</div>
14+
15+
## 📌 Important Info (Please Read)
16+
This project is **experimental** and was developed for **educational purposes** only. Please be aware that using automated tools on GitHub, including this application, may violate GitHub’s [Terms of Service](https://docs.github.com/en/site-policy/acceptable-use-policies/github-acceptable-use-policies#4-spam-and-inauthentic-activity-on-github), which prohibit activities such as:
17+
* Automated excessive bulk activity (e.g., mass following or starring)
18+
* Coordinated inauthentic interactions, such as fake accounts or bots
19+
* Rank abuse through automated following or starring
20+
* Spamming or cryptocurrency mining
21+
* Excessive burden on GitHub servers through automated requests
22+
23+
**By using this tool, you acknowledge the risk** of your account being flagged or banned for violating GitHub's policies. Proceed with caution, and use at your own risk. This tool is intended solely for learning purposes, and the developer is not responsible for any misuse or potential consequences.
24+
25+
## 👥 What is this project?
26+
This project is a Node.js application that automates following and unfollowing users on GitHub at random intervals, simulating human-like behavior. It uses a queue system to manage actions, integrates logging for tracking activity, ensures compliance with GitHub’s API rate limits, and helps boost your profile growth, presence, and interactions by automatically engaging with users. Designed for long-term, 24/7 operation, it efficiently handles large volumes of users by optimizing API calls and minimizing redundant actions, ensuring smooth and resource-effective performance.
27+
28+
This project was built using Node 16.20.2 on Ubuntu (Linux)
29+
30+
## 🛠 Installation & setup
31+
32+
1. Clone repository OR download the [latest release](https://github.com/KevinTrinh1227/Github-Auto-Followers-Bot/releases)
33+
34+
```sh
35+
git clone https://github.com/KevinTrinh1227/Github-Followers-Bot
36+
```
37+
38+
```sh
39+
cd Github-Auto-Followers-Bot
40+
```
41+
42+
2. **OPTIONAL**: Use the correct Node version using [NVM](https://github.com/nvm-sh/nvm) (Node v16.20.2)
43+
44+
```sh
45+
nvm install 16
46+
```
47+
48+
```sh
49+
nvm alias default 16
50+
```
51+
52+
3. Install the dependencies using npm or yarn
53+
54+
```sh
55+
npm install
56+
```
57+
58+
```sh
59+
yarn install
60+
```
61+
62+
## 🚀 Start the application
63+
64+
1. Now run the application
65+
66+
```sh
67+
npm start
68+
```
69+
70+
```sh
71+
yarn run start
72+
```

0 commit comments

Comments
 (0)