Giter VIP home page Giter VIP logo

see-image-diff's Introduction

See Image Diff

It takes two folders, base and current full of wonderful images with same names and ganarates a diff folder in given destination folder with the same names. Also, it generates a JSON blob with the comparison info and a neat web app to navigate through this image files. This uses jimp to compare the images which uses an awesome library pixelmatch.

Test & Deploy npm version

Watch the video

To install...

npm install see-image-diff

(or)

yarn add see-image-diff

Usage...

Image comparison utility

  It takes two folders, base and current full of images with same names and     
  ganarates a diff folder in given destination location with the same names.    
  Also, it generates a JSON blob and a neat web app to navigate through this    
  image files. It uses jimp npm module to compare the images.                   

Synopsis

  $ see-image-diff --baseDir ./base --currentDir ./current --destDir ./diff     
  [--reportFileName "results.json"]                                             
  $ see-image-diff --help                                                       

Options

  -b, --baseDir folder        Baseline images folder used for comparison. Should be flat list of image      
                              files. Can contain a thumbnail folder with same image names.                  
  -c, --currentDir folder     Current images folder used for comparison. Should be flat list of image       
                              files. Can contain a thumbnail folder with same image names.                  
  -d, --destDir folder        Destination folder to same all the diff images. Utility will overwrite any    
                              existing files in this locaiton.                                              
  -t, --threshold number      (Optional) Defaults to 0.1. Ranges 0-1.                                       
  --reportFileName filename   (Optional) Defaults to report.json.                                           
  -h, --help                  Print usage                                                                   

Roadmap

  • Refactor UI navbar
  • Fix image viewer issues
  • Add zoom option to image viewer
  • Provider a filer server to upload and to manage multiple versions - Requires a lot of effort so might not be coming soon.

see-image-diff's People

Contributors

actions-user avatar ravidasari avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

zouhenry

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.