README.md 1.33 KB
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 4
[![PyPI](https://img.shields.io/pypi/v/validata-ui.svg)](https://pypi.python.org/pypi/validata-ui)

Christophe Benz's avatar
Christophe Benz committed
5
Validata user interface
Pierre Dittgen's avatar
Pierre Dittgen committed
6

7
## Usage
Pierre Dittgen's avatar
Pierre Dittgen committed
8

9 10 11 12 13 14 15 16 17 18 19 20
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://git.opendatafrance.net/validata/validata-docker

## Develop
Pierre Dittgen's avatar
Pierre Dittgen committed
21

22
### Install
23

Christophe Benz's avatar
Christophe Benz committed
24
We recommend using [virtualenv](https://virtualenv.pypa.io/en/stable/).
25 26

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

28 29 30 31
```bash
pip install -e .
```

32 33 34 35 36 37 38 39 40
Validata UI depends on [Validata API](https://git.opendatafrance.net/validata/validata-api/), so you must install it also.

PDF report generation uses [Headless Chromium](https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md):

```bash
apt install -y chromium
```

### Configure
41 42 43 44 45 46 47 48 49

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

Customize the configuration variables in `.env` file.

Do not commit `.env`.

50
### Serve
51

Christophe Benz's avatar
Christophe Benz committed
52 53
Start the web server...

54
```bash
Christophe Benz's avatar
Christophe Benz committed
55 56 57 58
./serve.sh
```

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