https://github.com/jochendiekenbrock/image-comparison-backend

Backend of an image comparison solution. It reads the results of image comparisons performed by the https://github.com/JochenDiekenbrock/image-comparison-frontend and allows to manage them.
https://github.com/jochendiekenbrock/image-comparison-backend

ci continuous-integration image-comparison jenkins

Last synced: 3 months ago
JSON representation

Backend of an image comparison solution. It reads the results of image comparisons performed by the https://github.com/JochenDiekenbrock/image-comparison-frontend and allows to manage them.

• Host: GitHub
• URL: https://github.com/jochendiekenbrock/image-comparison-backend
• Owner: JochenDiekenbrock
• License: gpl-3.0
• Created: 2018-09-20T21:13:51.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T14:21:38.000Z (about 2 years ago)
• Last Synced: 2024-09-30T09:25:15.756Z (3 months ago)
• Topics: ci, continuous-integration, image-comparison, jenkins
• Language: TypeScript
• Homepage:
• Size: 1.33 MB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Image comparison backend

The image comparison backend works together with the

[image comparison frontend](https://github.com/jochendiekenbrock/image-comparison-frontend)

to provide the creation and management of automated image comparisons in an continous 

integration environment.

The image comparison frontend is used in end to end tests run in the CI environment to 

take images during the test

and compare these images to base images that are known to be correct. The frontend stores

these images together with test result information and difference images, if applicable.

If a test fails, the CI process should report this.

Using the image comparison backend, the test results can be evaluated. If the comparison failed

because of a bug, a developer can fix this and the CI should report now that the comparison no longer fails.

If the comparison failed but the new image is correct, perhaps because of a new feature,

the image comparison backend offers an option to accept the new image. The test result will be updated 

and the new image will be used from now on as new base image.

Requirements:

 * Node v10 (if you want to develop or run without docker)

 * Docker (if using the docker image (recommended))

## Getting Started

Using Docker (recommended):

```sh

sudo docker run -p :3000 -v :/home/node/app/public/data -d jochendiekenbrock/image-comparison-backend

```

(replace `````` with a port on your system, for example 80 and 

`````` with the directory on your system, where the test data resides, 

for example /public/data)

Run manually or for development:

```sh

yarn install

yarn start-dev

```

If no test result data is found in /public/data (or the data directory you specified in ```src/config.ts```),

example data from /public/example-data is used.

## License

[GPL-3.0-or-later](./LICENSE.txt)