0.0.1 • Published 3 years ago

peek-js v0.0.1

Weekly downloads
2
License
ISC
Repository
-
Last release
3 years ago

Contributors Forks Stargazers Issues

About Peek

Peek Screen Shot

Taking screenshots of web projects can be time consuming if there are lots of pages and you need to do it in differents resolutions. Peek helps you to automate these things : enter your domain, your pages, the resolution and your screenshots will automatically arrive in your folders !

Built With

  • 🖊️ NodeJS
  • 💻 Puppeteer

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

These are the tools required to make the project work properly:

  • NodeJS 12.13.0 or later

Installation

  1. Clone the repo
git clone https://github.com/NicolasBrondin/peek
  1. Open the folder
cd peek
  1. Install the dependencies
npm install
  1. Launch the CLI
npm start

Usage

To use the tool, simply follow the guidelines of the command-line interface and you will get your screenshots in no time.

This can be used to show a project, or to generate images for open-graph metadata for example.

Contact

Nicolas Brondin-Bernard - @NicolasBrondin - nicolas@brondin.com

Project Link: https://github.com/NicolasBrondin/peek