Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/torstendittmann/genauigkeit
Visual testing for Storybook
https://github.com/torstendittmann/genauigkeit
Last synced: about 1 month ago
JSON representation
Visual testing for Storybook
- Host: GitHub
- URL: https://github.com/torstendittmann/genauigkeit
- Owner: TorstenDittmann
- Created: 2024-06-03T00:16:53.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-08-12T10:38:32.000Z (4 months ago)
- Last Synced: 2024-10-13T03:19:16.604Z (2 months ago)
- Language: JavaScript
- Homepage: https://genauigkeit.dev
- Size: 4.08 MB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# genauigkeit
## Visual Regression Testing for Storybook
**genauigkeit** (German for "accuracy") is a library that simplifies visual regression testing for your components in Storybook. It leverages the power of concurrency and Docker containers to ensure fast and reliable tests.
## Key Features
- **Fast:** Concurrent testing significantly reduces test execution time.
- **Local:** Run tests locally without the need for a cloud service.
- **Reliable:** Docker containers provide a consistent isolated conditions for screenshots, eliminating environmental discrepancies.
- **Easy to Use:** Integrate genauigkeit seamlessly into your existing Storybook workflow.
## Requirements
- Node.js 20 or higher
- Docker
## Installation
```sh
npx nypm add genauigkeit
```
## Usage
Generate a configuration file by running the following command:
```sh
npx genauigkeit init
```
### Generate References
To generate reference screenshots, execute the following command:
```sh
npx genauigkeit generate
```
### Run Tests
To run tests, execute the following command:
```bash
npx genauigkeit test
```
### package.json
You can also add scripts to your package.json:
```json
{
"scripts": {
"genauigkeit:generate": "genauigkeit generate",
"genauigkeit:test": "genauigkeit test"
}
}
```
## Contributing
We welcome contributions! Please refer to the [contribution guidelines](./CONTRIBUTING.md) before submitting a pull request.
## License
This project is licensed under the MIT License.