Skip to content

Puppeteer Website Screenshots Generator for UI Regression testing or general UI Testing

Notifications You must be signed in to change notification settings

BeKnowDo/bkd-puppeteer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Puppeteer: CLI based Website Screenshots

This is a straight forward Puppeteer based website screenshot generator.


How it works

We use Puppeteer to identify and capture any given website's primary navigation links (urls): nav > ul > li > a.

For every qualified navigation item, we capture and add the title and href values into an array. Then we simply iterate through that array, use Puppeteer's goto method to capture both default viewport and full-page screenshots.


Installation & Configuration

  • npm i bkd-puppeteer

  • Create an .env file in the root of the project's directory

    • Add baseline variables as shown below

    (If the site has simple authentication, provide a username and password):

    HOST=https://npr.com
    USER=yourUserName
    PASS=yourPassword
    DESTINATION=build-directory-of-choice
    

Where screenshots are published

  • Screenshots are generated into the directory you've indicated in .env
  • Filenames follow this format: Page name - Device name - Height - width.jpg
    • Realworld example: Contact-Us-iPad-768x1024.fullscreen.jpg

Available Scripts

  • npm run puppet
  • npm run puppet-dev - only difference is the use of nodemon

That's pretty much it. I know. Nothing Earth shattering but clients find it useful because it's a real time-saver in UI Regression Testing.

Hopefully someone out there will find this helpful. I'm going to continue to extend this (mostly for my own personal development).

If anyone has suggestions...feel free to throw ideas out there :)

created by BKD Digital Inc.

About

Puppeteer Website Screenshots Generator for UI Regression testing or general UI Testing

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published