GitHub Followers Management API

---

---

About |  Why this project |  Minimal Requirements |  Technologies |  Installation |  Requests |  How To Contribute |  License

---

Click here do consult the API documentation

---

ℹ️ About

GitHub Followers Management it's an API to manage your GitHub followers and discover more about them. You can find out, for example, users who are following you, but you don't follow them back and find out users you follow, but don't follow you back. The API uses the GitHub Developers API, it just provides your GitHub user in the endpoint and discovers what you want, you don't need even to login at GitHub

⁉️ Reason

This is a project to help the GitHub community, use and try the GitHub Developers API, besides, use the knowledge at the used technologies to practice.

🌱 Minimal Requirements

• Node v8+ or Docker
• NPM or Yarn.

🚀 Technologies

This API was developed using the following technologies:

• Node.js
• Express.js
• Docker
• Docker-compose
• Swagger
• GitHub API

🔧 Installation

# Cloning the repository
git clone https://github.com/lucas-felinto/github-followers-management.git

# Changing the directory
cd github-followers-management

## Install the dependencies
npm install

# Start the application
npm start or docker-compose up

↪️ Requests

• GET /api/v1/not-follow-you
• Returns a users list who don't follow you back
• Example Request: /api/v1/not-follow-you?user=octocat

Code: 200 OK
[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  {
    "login": "lucas-felinto",
    "id": 62717182,
    "node_id": "MDQ6VXNlcjYyNzE3MTgy",
    "avatar_url": "https://avatars3.githubusercontent.com/u/62717182?v=4",
    "gravatar_id": "",
    "url": "https://api.github.com/users/lucas-felinto",
    "html_url": "https://github.com/lucas-felinto",
    "followers_url": "https://api.github.com/users/lucas-felinto/followers",
    "following_url": "https://api.github.com/users/lucas-felinto/following{/other_user}",
    "gists_url": "https://api.github.com/users/lucas-felinto/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/lucas-felinto/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/lucas-felinto/subscriptions",
    "organizations_url": "https://api.github.com/users/lucas-felinto/orgs",
    "repos_url": "https://api.github.com/users/lucas-felinto/repos",
    "events_url": "https://api.github.com/users/lucas-felinto/events{/privacy}",
    "received_events_url": "https://api.github.com/users/lucas-felinto/received_events",
    "type": "User",
    "site_admin": false
  }
]

• GET /api/v1/you-not-follow
• Returns a users list who follows you, but you don't follow back
• Example Request: /api/v1/you-not-follow?user=octocat

Code: 200 OK
[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://api.github.com/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://api.github.com/users/octocat/followers",
    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
    "organizations_url": "https://api.github.com/users/octocat/orgs",
    "repos_url": "https://api.github.com/users/octocat/repos",
    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
    "received_events_url": "https://api.github.com/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  },
  {
    "login": "lucas-felinto",
    "id": 62717182,
    "node_id": "MDQ6VXNlcjYyNzE3MTgy",
    "avatar_url": "https://avatars3.githubusercontent.com/u/62717182?v=4",
    "gravatar_id": "",
    "url": "https://api.github.com/users/lucas-felinto",
    "html_url": "https://github.com/lucas-felinto",
    "followers_url": "https://api.github.com/users/lucas-felinto/followers",
    "following_url": "https://api.github.com/users/lucas-felinto/following{/other_user}",
    "gists_url": "https://api.github.com/users/lucas-felinto/gists{/gist_id}",
    "starred_url": "https://api.github.com/users/lucas-felinto/starred{/owner}{/repo}",
    "subscriptions_url": "https://api.github.com/users/lucas-felinto/subscriptions",
    "organizations_url": "https://api.github.com/users/lucas-felinto/orgs",
    "repos_url": "https://api.github.com/users/lucas-felinto/repos",
    "events_url": "https://api.github.com/users/lucas-felinto/events{/privacy}",
    "received_events_url": "https://api.github.com/users/lucas-felinto/received_events",
    "type": "User",
    "site_admin": false
  }
]

🔗 How To Contribute

• Fork the repository
• Git clone your forked repository git clone https://github.com/your-user/github-followers-management.git
• Create a branch with your feature git checkout -b your-branch-name
• Commiy your changes git add . && git commit -m "your commit changes"
• Push your changes git push
• Open a pull request in this repository with your branch

License

This project is under MIT license. See the documentation LICENSE for details.