https://github.com/vanicce/repo-screenshot

Using Puppeteer JS library to screenshot a webpage in Desktop and Mobile
https://github.com/vanicce/repo-screenshot

nodejs puppeteer puppeteer-screenshot

Last synced: about 1 month ago
JSON representation

Using Puppeteer JS library to screenshot a webpage in Desktop and Mobile

• Host: GitHub
• URL: https://github.com/vanicce/repo-screenshot
• Owner: vanicce
• Created: 2023-12-30T23:31:59.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-01-09T00:26:36.000Z (12 months ago)
• Last Synced: 2024-11-14T13:49:07.740Z (about 1 month ago)
• Topics: nodejs, puppeteer, puppeteer-screenshot
• Language: JavaScript
• Homepage:
• Size: 18.9 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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:

https://github.com/lucwx/web-screenshot/assets/103083001/74ce95d0-fcc5-4d09-ba69-5075917236af

## Prerequisites

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

## Installation

 1. Clone the repository:

```bash

git clone https://github.com/lucwx/repo-screenshot.git

```

 2. Navigate to the project directory:

```bash

cd repo-screenshot

```

 3. Install the dependencies:

```bash

npm install

```

## How to Use

 1. Run the main script:

```bash

node index.js

```

 2. Follow the instructions to input the repository details.

Example Directory Structure

```bash

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.