gm-webdesign / peek Goto Github PK

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 !

• 🖊️ NodeJS
• 💻 Puppeteer

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

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

• NodeJS 12.13.0 or later

1. Clone the repo

git clone https://github.com/NicolasBrondin/peek

2. Open the folder

cd peek

3. Install the dependencies

npm install

4. Launch the CLI

npm start

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.

Nicolas Brondin-Bernard - @NicolasBrondin - [email protected]

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