Skip to content
Snippets Groups Projects
Unverified Commit 4ab509ed authored by Markus Matoni's avatar Markus Matoni
Browse files

update readme

parent 8729e558
No related branches found
No related tags found
No related merge requests found
# aqinda-full
![alt text](img/constrainify-logo-no-background.svg)
## Build & Run
1. Make sure you have a secret key stored in the file `session_key.env` that looks like this:
```
6zgm8raxznijv7781k49ut5m9
```
2. Make sure you have installed docker and run:
[![Latest Version](https://gitlab.gwdg.de/aqinda/constrainify-core/-/badges/release.svg)](https://gitlab.gwdg.de/aqinda/constrainify-core/-/releases)
# Constrainify - Simplify Creating Quality Constraints to Analyze Data
Constrainify is an application that allows users to create quality constraints and perform data quality analysis. Users can define quality constraints in the form of intuitive sentences based on templates. They can select a set from the defined constraints and run it for their quality analysis. The two data quality tools [MQAF](https://github.com/pkiraly/qa-catalogue) and [QPM](https://github.com/Project-KONDA/pattern-based-quality-analysis) work in the background and create a detailed and understandable quality report.
## Why Constrainify?
Typical Data Quality Tools often require a lot of skills. In addition to the typical analytical skills of a data analyst, expert knowledge of data and data models is also required. Constrainify takes care about the details of the data and the structure of the data model behind it.
Users only need an affinity for quality problems and an interest in high data quality. Constrainify lets users define constraints in natural language and easy-to-understand sentences. Users can define their own constraints based on templates and adapt them to their data. The quality analysis runs in the background and creates a corresponding quality report. No account is required and the data remains temporary and anonymous.
## Demo
[Constrainify](https://constrainify.gwdg.de)
## Getting Started
> **Step 1** Make sure you have installed docker, clone this repository and navigate to its directory.
> **Step 2** Set up a secret key stored in the file `session_key.env` that looks like this: `6zgm8raxznijv7781k49ut5m9`.
> **Step 3** Make sure you have a docker built image of constrainify-core, qpm and mqaf.
> **Step 4** User Docker to run the application:
```
docker compose up
```
> **Step 5** Go to http://localhost:8000 on any browser and enjoy Constrainfy!
\ No newline at end of file
img/aqinda-logo-removebg.png

164 KiB

img/aqinda-logo.png

125 KiB

<svg xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.dev/svgjs" width="1500" height="303" viewBox="0 0 1500 303"><g transform="matrix(1,0,0,1,-0.9084522071641459,-0.27416466237934856)"><svg viewBox="0 0 396 80" data-background-color="#edffde" preserveAspectRatio="xMidYMid meet" height="303" width="1500" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"><g id="tight-bounds" transform="matrix(1,0,0,1,0.24008861730862918,0.07238670953910287)"><svg viewBox="0 0 395.52 79.85522658092177" height="79.85522658092177" width="395.52"><g><svg viewBox="0 0 395.52 79.85522658092177" height="79.85522658092177" width="395.52"><g><svg viewBox="0 0 395.52 79.85522658092177" height="79.85522658092177" width="395.52"><g id="textblocktransform"><svg viewBox="0 0 395.52 79.85522658092177" height="79.85522658092177" width="395.52" id="textblock"><g><svg viewBox="0 0 395.52 79.85522658092177" height="79.85522658092177" width="395.52"><path d="M394.594 17.127C392.735 8.838 387.435 6.534 387.435 6.534 371.165-2.003 350.86-0.163 332.619 1.063 300.414 1.113 268.339 2.937 236.208 3.915 168.767 4.064 100.749 1.611 33.643 7.661 27.339 9.518-6.54 8.026 1.121 18.188 3.129 22.416 10.456 27.107 10.232 30.987 11.236 31.666 12.631 30.108 13.226 31.086 15.309 33.722 18.711 32.479 21.501 34.037 17.614 38.198 20.403 41.663 23.062 45.293 18.377 46.238 12.371 45.791 9.675 48.924 9.396 51.195 7.89 50.764 6.235 50.664 5.026 50.598 2.59 50.847 2.999 51.56 4.394 53.997-1.594 55.406 2.162 57.793-0.422 60.379 3.948 62.617 3.353 65.419 3.278 65.982 3.687 66.463 4.338 66.596 7.22 67.309 3.018 68.701 3.464 70.21 33.029 80.521 65.104 73.393 95.394 78.134 103.259 74.818 97.346 79.311 100.489 78.615 102.943 77.802 104.728 81.168 107.499 79.261 107.927 78.714 107.276 77.421 108.8 77.67 109.6 77.802 110.307 77.769 110.418 77.007 110.586 75.863 109.117 76.576 108.726 75.979 112.947 72.962 111.906 80.14 115.866 79.842 115.68 78.963 114.528 77.703 116.889 77.869 119.232 76.609 119.306 75.564 121.389 78.399 121.463 79.013 121.835 79.444 122.43 79.742 128.938 76.659 135.409 80.836 142.233 79.444 146.417 77.919 150.433 80.273 154.672 79.692 156.16 79.228 157.666 78.399 159.098 79.792 176.632 80.09 195.319 78.847 211.943 79.842 256.364 77.985 303.836 80.604 350.674 78.151 361.719 77.206 373.192 75.863 383.958 74.785 383.958 74.785 392.679 71.834 392.679 58.572S394.538 46.968 394.817 36.408C395.096 25.847 396.398 25.416 394.538 17.127Z" opacity="1" fill="#0077b6" data-fill-palette-color="tertiary"></path><g transform="matrix(1,0,0,1,55.76832,26.230666666666668)"><svg width="283.98335999999995" viewBox="2.75 -36.8 388.72 37.5" height="27.393893247588423" data-palette-color="#ffffff"><path d="M19.1 0.7L19.1 0.7Q14 0.7 10.33-1.55 6.65-3.8 4.7-7.85 2.75-11.9 2.75-17.35L2.75-17.35Q2.75-23.15 4.88-27.53 7-31.9 10.8-34.35 14.6-36.8 19.5-36.8L19.5-36.8Q23.4-36.8 26.63-35.23 29.85-33.65 31.85-30.85L31.85-30.85Q31.6-29.95 30.58-29 29.55-28.05 28.55-27.75L28.55-27.75Q26.75-30.1 24.45-31.2 22.15-32.3 19.5-32.3L19.5-32.3Q15.95-32.3 13.25-30.45 10.55-28.6 9.05-25.3 7.55-22 7.55-17.6L7.55-17.6Q7.55-13.45 8.93-10.35 10.3-7.25 12.98-5.53 15.65-3.8 19.5-3.8L19.5-3.8Q22.85-3.8 25.3-5.15 27.75-6.5 29.75-8.95L29.75-8.95Q30.7-8.65 31.7-7.85 32.7-7.05 33.1-6.25L33.1-6.25Q30.8-2.85 27.18-1.07 23.55 0.7 19.1 0.7ZM53.9 0.7L53.9 0.7Q49.1 0.7 45.45-1.68 41.8-4.05 39.75-8.28 37.7-12.5 37.7-18.05L37.7-18.05Q37.7-23.6 39.75-27.83 41.8-32.05 45.45-34.43 49.1-36.8 53.9-36.8L53.9-36.8Q58.7-36.8 62.32-34.43 65.95-32.05 67.97-27.85 70-23.65 70-18.05L70-18.05Q70-12.5 67.97-8.28 65.95-4.05 62.32-1.68 58.7 0.7 53.9 0.7ZM53.85-3.8L53.85-3.8Q57.3-3.8 59.85-5.58 62.4-7.35 63.8-10.58 65.2-13.8 65.2-18.05L65.2-18.05Q65.2-22.35 63.8-25.55 62.4-28.75 59.85-30.53 57.3-32.3 53.9-32.3L53.9-32.3Q50.5-32.3 47.92-30.53 45.35-28.75 43.92-25.55 42.5-22.35 42.5-18.05L42.5-18.05Q42.5-13.8 43.9-10.58 45.3-7.35 47.87-5.58 50.45-3.8 53.85-3.8ZM80.05 0.35L80.05 0.35Q78.8 0.35 77.75 0L77.75 0 77.75-36.1Q78.8-36.45 80.09-36.45L80.09-36.45Q80.55-36.45 81.02-36.4 81.5-36.35 82-36.2L82-36.2 101.5-8.65 101.5-36.1Q102.55-36.45 103.84-36.45L103.84-36.45Q104.95-36.45 106.15-36.1L106.15-36.1 106.15 0Q105.3 0.35 104.25 0.35L104.25 0.35Q103.09 0.35 102.09 0L102.09 0 82.4-27.85 82.4 0Q81.2 0.35 80.05 0.35ZM125.69 0.65L125.69 0.65Q120.84 0.6 117.79-1.53 114.74-3.65 113.74-7.2L113.74-7.2Q114.29-8.15 115.52-8.72 116.74-9.3 117.84-9.2L117.84-9.2Q118.74-6.5 120.84-5.1 122.94-3.7 125.94-3.75L125.94-3.75Q129.14-3.8 131.09-5.43 133.04-7.05 133.04-9.85L133.04-9.85Q133.04-14.1 128.59-15.35L128.59-15.35 121.94-17.2Q118.44-18.2 116.44-20.63 114.44-23.05 114.44-26.4L114.44-26.4Q114.44-29.4 115.97-31.75 117.49-34.1 120.17-35.43 122.84-36.75 126.29-36.75L126.29-36.75Q130.14-36.75 133.22-35.13 136.29-33.5 137.54-30.85L137.54-30.85Q137.09-30.05 136.07-29.28 135.04-28.5 133.84-28.1L133.84-28.1Q131.39-32.35 126.14-32.35L126.14-32.35Q123.04-32.35 121.09-30.78 119.14-29.2 119.14-26.7L119.14-26.7Q119.14-22.7 124.29-21.25L124.29-21.25 130.19-19.65Q133.74-18.7 135.74-16.13 137.74-13.55 137.74-9.9L137.74-9.9Q137.74-6.7 136.17-4.3 134.59-1.9 131.87-0.63 129.14 0.65 125.69 0.65ZM156.44 0.25L156.44 0.25Q155.94 0.25 155.37 0.18 154.79 0.1 154.14 0L154.14 0 154.14-31.9 142.29-31.9Q141.49-34.25 142.29-36.1L142.29-36.1 170.64-36.1Q171.04-35.3 171.04-34.1 171.04-32.9 170.64-31.9L170.64-31.9 158.84-31.9 158.84 0Q158.19 0.1 157.59 0.18 156.99 0.25 156.44 0.25ZM179.89 0.35L179.89 0.35Q178.64 0.35 177.59 0L177.59 0 177.59-36.1 189.54-36.1Q192.89-36.1 195.76-35.08 198.64-34.05 200.41-31.75 202.19-29.45 202.19-25.7L202.19-25.7Q202.19-22.8 201.04-20.73 199.89-18.65 198.09-17.32 196.29-16 194.24-15.25L194.24-15.25 203.19-2.7Q202.79-1.65 201.76-0.8 200.74 0.05 199.54 0.3L199.54 0.3 189.24-14.15Q188.69-14.1 188.19-14.1L188.19-14.1 182.24-14.1 182.24 0Q181.04 0.35 179.89 0.35ZM189.94-31.8L189.94-31.8 182.24-31.8 182.24-18.4 188.19-18.4Q189.74-18.4 191.36-18.73 192.99-19.05 194.34-19.83 195.69-20.6 196.54-22 197.39-23.4 197.39-25.55L197.39-25.55Q197.39-28.6 195.29-30.2 193.19-31.8 189.94-31.8ZM216.04-9.25L212.14 0.7Q211.04 0.55 209.94 0.15 208.84-0.25 208.09-1L208.09-1 222.09-36.1Q222.89-36.45 223.99-36.45L223.99-36.45Q225.24-36.45 225.94-36.1L225.94-36.1 240.04-1.05Q239.39-0.35 238.29 0.08 237.19 0.5 235.84 0.7L235.84 0.7 231.89-9.25 216.04-9.25ZM223.94-29.3L217.74-13.55 230.19-13.55 223.94-29.3ZM263.63 0L245.63 0Q245.28-0.85 245.28-2.13 245.28-3.4 245.63-4.2L245.63-4.2 252.33-4.2 252.33-31.9 245.63-31.9Q245.28-32.75 245.28-34.02 245.28-35.3 245.63-36.1L245.63-36.1 263.63-36.1Q263.98-35.3 263.98-34.02 263.98-32.75 263.63-31.9L263.63-31.9 256.98-31.9 256.98-4.2 263.63-4.2Q263.98-3.4 263.98-2.13 263.98-0.85 263.63 0L263.63 0ZM274.53 0.35L274.53 0.35Q273.28 0.35 272.23 0L272.23 0 272.23-36.1Q273.28-36.45 274.58-36.45L274.58-36.45Q275.03-36.45 275.5-36.4 275.98-36.35 276.48-36.2L276.48-36.2 295.98-8.65 295.98-36.1Q297.03-36.45 298.33-36.45L298.33-36.45Q299.43-36.45 300.63-36.1L300.63-36.1 300.63 0Q299.78 0.35 298.73 0.35L298.73 0.35Q297.58 0.35 296.58 0L296.58 0 276.88-27.85 276.88 0Q275.68 0.35 274.53 0.35ZM327.23 0L309.23 0Q308.88-0.85 308.88-2.13 308.88-3.4 309.23-4.2L309.23-4.2 315.93-4.2 315.93-31.9 309.23-31.9Q308.88-32.75 308.88-34.02 308.88-35.3 309.23-36.1L309.23-36.1 327.23-36.1Q327.58-35.3 327.58-34.02 327.58-32.75 327.23-31.9L327.23-31.9 320.58-31.9 320.58-4.2 327.23-4.2Q327.58-3.4 327.58-2.13 327.58-0.85 327.23 0L327.23 0ZM338.13 0.2L338.13 0.2Q337.57 0.2 337 0.15 336.43 0.1 335.82 0L335.82 0 335.82-36.1 356.88-36.1Q357.18-35.2 357.18-33.95 357.18-32.7 356.88-31.75L356.88-31.75 340.47-31.75 340.47-20.55 355.27-20.55Q355.82-18.35 355.27-16.2L355.27-16.2 340.47-16.2 340.47 0Q339.93 0.1 339.32 0.15 338.72 0.2 338.13 0.2ZM376.42 0.35L376.42 0.35Q375.27 0.35 374.07 0L374.07 0 374.07-13.8 361.22-34.3Q361.77-35.35 362.97-35.98 364.17-36.6 365.17-36.6L365.17-36.6 376.42-18.65 387.57-36.55Q388.72-36.6 389.92-35.95 391.12-35.3 391.47-34.35L391.47-34.35 378.72-13.75 378.72 0Q377.67 0.35 376.42 0.35Z" opacity="1" transform="matrix(1,0,0,1,0,0)" fill="#ffffff" class="wordmark-text-0" data-fill-palette-color="quaternary" id="text-0"></path></svg></g></svg></g></svg></g></svg></g><g></g></svg></g><defs></defs></svg><rect width="395.52" height="79.85522658092177" fill="none" stroke="none" visibility="hidden"></rect></g></svg></g></svg>
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment