README.md 656 Bytes
Newer Older
Christophe Benz's avatar
Christophe Benz committed
1
# Validata UI
Pierre Dittgen's avatar
Pierre Dittgen committed
2

Christophe Benz's avatar
Christophe Benz committed
3
Validata user interface
Pierre Dittgen's avatar
Pierre Dittgen committed
4

Pierre Dittgen's avatar
Pierre Dittgen committed
5 6 7 8 9 10 11 12
## Requirements

PDF report uses [Headless Chromium](https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md).
Please install:
```bash
apt install -y chromium
```

Christophe Benz's avatar
Christophe Benz committed
13
## Install
14

Christophe Benz's avatar
Christophe Benz committed
15
We recommend using [virtualenv](https://virtualenv.pypa.io/en/stable/).
16 17

Install the project dependencies:
Christophe Benz's avatar
Christophe Benz committed
18

19 20 21 22
```bash
pip install -e .
```

23 24 25 26 27 28 29 30 31 32 33 34
## Configuration

```bash
cp .env.example .env
```

Customize the configuration variables in `.env` file.

Do not commit `.env`.

See also: https://github.com/theskumar/python-dotenv

35 36
## Development

Christophe Benz's avatar
Christophe Benz committed
37 38
Start the web server...

39
```bash
Christophe Benz's avatar
Christophe Benz committed
40 41 42 43
./serve.sh
```

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