# ui-diff

> 🖼 The tool for frontend screenshot testing

Latest version **1.2.5** (published 2020-05-23) · NO LICENSE license · 0 weekly downloads

## Install

```sh
npm install ui-diff
pnpm add ui-diff
yarn add ui-diff
bun add ui-diff
```

Provides the command `screenshot`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.5 |
| Published | 2020-05-23 |
| First published | 2020-01-11 |
| Weekly downloads | 0 |
| License | NO LICENSE |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 7.2 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Albin Groen |
| Maintainers | albingroen |
| Keywords | testing, tests, frontend-testing, puppeteer, frontend, screenshots, screenshot-testing |

## Links

- npm: https://www.npmjs.com/package/ui-diff
- Repository: https://github.com/albingroen/ui-diff
- Homepage: https://github.com/albingroen/ui-diff#readme
- Issues: https://github.com/albingroen/ui-diff/issues
- npm.io page: https://npm.io/package/ui-diff

## Dependencies (4)

- [ora](https://npm.io/package/ora.md) ^4.0.3
- [axios](https://npm.io/package/axios.md) ^0.19.1
- [minimist](https://npm.io/package/minimist.md) ^1.2.0
- [puppeteer](https://npm.io/package/puppeteer.md) ^3.0.2

## Alternatives

- [@snazzah/davey](https://npm.io/package/@snazzah/davey.md) — 1.5M weekly downloads
- [@vendure/testing](https://npm.io/package/@vendure/testing.md) — 8.3K weekly downloads
- [vue-simple-context-menu](https://npm.io/package/vue-simple-context-menu.md) — 6.6K weekly downloads
- [cypress-webpack-preprocessor-v5](https://npm.io/package/cypress-webpack-preprocessor-v5.md) — 2.1K weekly downloads
- [@backstage/plugin-catalog-backend-module-puppetdb](https://npm.io/package/@backstage/plugin-catalog-backend-module-puppetdb.md) — 1.3K weekly downloads

## Recent versions

- 1.2.5 (latest) — 2020-05-23
- 1.2.4 — 2020-05-23
- 1.2.3 — 2020-05-23
- 1.2.2 — 2020-04-26
- 1.2.1 — 2020-02-04
- 1.2.0 — 2020-02-03
- 1.1.0 — 2020-02-03
- 1.0.6 — 2020-01-13
- 1.0.5 — 2020-01-11
- 1.0.4 — 2020-01-11
- 1.0.3 — 2020-01-11
- 1.0.2 — 2020-01-11
- 1.0.1 — 2020-01-11
- 1.0.0 — 2020-01-11

## README

[![npm version](https://badge.fury.io/js/ui-diff.svg)](https://badge.fury.io/js/ui-diff)

<center><img src="./static/logo.png" width="100" /></center>

# ui-diff

🖼 The tool for frontend screenshot testing

## How to use it

### 1. Create a new project on ui-diff

[app.ui-diff.com/new-project](https://app.ui-diff.com/new-project)

### 2. Install dependency with yarn or npm

    yarn add ui-diff

### 3. Supply configuration files (in project root)

These can be found at [app.ui-diff.com/documentation](https://app.ui-diff.com/documentation)

### 4. Run screenshot tests

    yarn screenshots

Command line options can also be found at [app.ui-diff.com/documentation](https://app.ui-diff.com/documentation)

## Built using

- 📸 [puppeteer](https://pptr.dev/)
- 🌐 [ora](https://github.com/sindresorhus/ora)
- ⚙️ [minimist](https://github.com/substack/minimist)
- ⚡️ [axios](https://github.com/axios/axios)

## Contributors

[<img alt="albingroen" src="https://avatars2.githubusercontent.com/u/19674362?v=4&s=117" width=117>](https://github.com/albingroen) |
:---:|
[albingroen](https://github.com/albingroen)|

---
_Source: https://npm.io/package/ui-diff · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
