validata-ui

Validata UI

Validata user interface

Usage

You can use the online instance of Validata:

• user interface: https://go.validata.fr/
• API: https://go.validata.fr/api/v1/
• API docs: https://go.validata.fr/api/v1/apidocs

Several software services compose the Validata stack. The recommended way to run it on your computer is to use Docker. Otherwise you can install each component of this stack manually, for example if you want to contribute by developing a new feature or fixing a bug.

Run with Docker

Read instructions at https://gitlab.com/validata-table/validata-docker

Develop

Install

We recommend using venv standard package:

python -m venv .venv
source .venv/bin/activate

Install the project dependencies (using last release of validata-core project):

pip install -r requirements.txt
pip install -r requirements-dev.txt
pip install -e .

To use a specific distant git development branch of validata-core project:

pip install -r requirements.txt
pip install -r requirements-dev.txt
pip uninstall validata_core
pip install git+https://gitlab.com/validata-table/validata-core.git@<development-branch-name>
pip install -e .

PDF report generation uses:

• either Headless Chromium (default)

apt install -y chromium

• or browserless.io pdf service (see .env.example to configure this option)

Configure

cp .env.example .env

Customize the configuration variables in .env file.

Do not commit .env.

Serve

Start the web server...

./serve.sh

... then open http://localhost:5601/

Test

UI tests can be launched using Cypress tool

Release a new version

• Update version in setup.py and CHANGELOG.md files
• Commit changes using Release as commit message
• Create git tag (starting with "v" for the release)
• Git push: git push && git push --tagss
• Check that container image is well built and pypi package is created (validata-ui pipelines)