Skip to content

Latest commit

 

History

History
48 lines (42 loc) · 1.22 KB

README.md

File metadata and controls

48 lines (42 loc) · 1.22 KB
Raw

Repo Screenshot

Project Description

The Repo Screenshot project is a simple tool for fetching GitHub repositories and taking screenshots of the homepages of the websites associated with these repositories. The screenshots are then stored in a directory with the name of the respective site.

Features

Fetch GitHub repositories Capture screenshots of the homepage of the site associated with the repository Store screenshots in the corresponding directory

Example Video:

example_video.mp4

Prerequisites

Make sure you have Node.js installed to run the project.

Installation

  1. Clone the repository:
git clone https://github.com/lucwx/repo-screenshot.git
  1. Navigate to the project directory:
cd repo-screenshot
  1. Install the dependencies:
npm install

How to Use

  1. Run the main script:
node index.js
  1. Follow the instructions to input the repository details. Example Directory Structure
repo-screenshot/
|-- screenshots/
|   |-- site1.com.png
|   |-- site2.org.png
|-- index.js
|-- README.md
|-- ...

Contribution

Contributions are welcome! Feel free to open issues and pull requests.