Giter VIP home page Giter VIP logo

shutter's Introduction

Shutter

Shutter captures screenshots of internal website pages and compares them for differences.

Travis branch npm npm npm

Installation

$ npm install -g site-shutter

Quick Start

Quickest way to compare two environments is to use the compare command, navigate to a folder you want the comparisons to appear and run the command.

Compare two sites:

$ shutter compare http://example.com http://staging.com

shutter compare accepts two urls or two folder paths containing screenshots. The screenshots must be named the same in each folder and must be (png)'s

$ shutter compare path/to/original/screenshots path/to/comparison/screenshots

Screenshots

With shutter screenshots it is possible to capture any number of environments then compare them.

Screenshot any number of environments:

$ shutter screenshots master=example.com develop=staging.example.com

Screenshots must follow the convention [ENVIRONMENT]=[DOMAIN] the [ENVIRONMENT] is used for the output folder. Do not use symbols in the environment.

Compare the output with:

$ shutter compare master develop

Command Line Options

This tool can also be further configured with the following command line flags.

-h, --help          output usage information
    --version       output the version number

Notes

  • Be patient the crawling and screenshot process are very cpu intensive
  • The first site passed to the command defines the internal page paths for all of the other sites
  • Any sites larger than (600 pages +) will fail (Don't try and crawl google :$)

Coming soon!

  • Usage with docker
  • Assign your own config values
    • Concurrency
    • Chunk size
    • Crawler depth
    • And many more
  • Module support
  • Better windows support
  • Spinners / loading bars to indicate time taken
  • Performance optimization

Licence

MIT

shutter's People

Contributors

moshie avatar

Stargazers

James Monger avatar Simon Adcock avatar Ben Read avatar Christopher Geary avatar

Watchers

 avatar  avatar

shutter's Issues

Ability to run in other directories with flag?

This is awesome! Could you allow us to specify a directory using a flag -d for example, so we can run this inside other directories (other than the one we're in?).

So, I want to be able to run: shutter -d path/to/screenshots and have it run as if it were in this directory.

๐Ÿ‘

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.