Giter Club home page Giter Club logo

repo-screenshot's Introduction

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.

repo-screenshot's People

Contributors

vanicce avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

repo-screenshot's Issues

Make a CLI app

make the repository into a CLI app posting in NPM to install and run in terminal

example usage:

npm install web-screenshot

explication: download the package on npm.

web-screenshot --user-'name of user'  

explication: --user define a user nickname to fetch projects in github api

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.