https://github.com/codechecks/vis-reg
https://github.com/codechecks/vis-reg
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/codechecks/vis-reg
- Owner: codechecks
- License: mit
- Created: 2019-08-13T08:11:14.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-11-28T07:19:21.000Z (over 4 years ago)
- Last Synced: 2025-10-06T08:18:56.723Z (5 months ago)
- Language: TypeScript
- Size: 457 KB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Visual Regression
Visual Regression on GitHub
## Install
```sh
npm install --save-dev @codechecks/vis-reg
```
## Usage
Are you new to codechecks? Check out
[getting started guide (it's simple)](https://github.com/codechecks/docs/blob/master/getting-started.md)!
Add to your `codechecks.yml` file:
```yml
checks:
- name: vis-reg
options:
collectionName: "E2E" # arbitrary name, for example: e2e, storybook
imagesPath: "./images/" # path when current images are stored
# ...
```
## API
## Contributing
All contributions are welcomed. Read more in [CONTRIBUTING.md](./CONTRIBUTING.md)
## Licence
MIT @ [codechecks.io](https://codechecks.io)