GitHub Scraper API

A powerful GitHub profile scraper API built with JavaScript, Express, and Puppeteer. This API analyzes profiles, followers, and following to identify mutual connections, providing valuable insights into your GitHub network.

Features

• Profile Analysis: Retrieves detailed information from GitHub profiles.
• Followers & Following: Fetches the list of followers and following for deeper connection analysis.
• Mutual Connections: Identifies mutual followers to help you understand the relationships in your network.

Installation

Make sure you have pnpm installed.

1. Clone the repository:

    git clone https://github.com/albertoalejandro10/github-scraper.git
    cd github-scraper

2. Install dependencies

   pnpm install

3. Create a .env file in the root directory and add the following environment variables:

   NODE_ENV=development
   PORT=2998
   PUPPETEER_HEADLESS=false

4. Start the API server:

   pnpm start

API Usage

This project exposes a single POST endpoint to scrape GitHub profiles.

Endpoint

POST /scrape

• URL: http://localhost:2998/scrape
• Body:

  {
    "username": "albertoalejandro10"
  }

Tech Stack

• JavaScript: Core language
• Express: Web framework
• Puppeteer: Headless browser for scraping GitHub profiles
• pnpm: Efficient package manager

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request. It would be great if you starred the project and share it with your github friends. Thank you.

License

This project is licensed under the MIT License.