diff --git a/README.md b/README.md index 8072bd0c1b4acb475c7c3e0e6655e20246ef9b62..996ad38fe843fff9b3500188a281cefc54d2fa66 100644 --- a/README.md +++ b/README.md @@ -22,12 +22,24 @@ Two clients named `trans-db-be` and `trans-db-fe`, with the `citizen` role withi ## Installation +### Get the code Clone this repository: ``` bash git clone https://git.code.tecnalia.com/across/public/citizen-front-end/transparency-dashboard/transparency-dashboard-ui.git ``` +### Configure properties files +Check the following `*.env` files and change the property values as required: +- `./mysql.env`: this file contains the properties related to the MySQL DB, as the username, to be used for creating the DB container. +- `./transparency_dashboard_backend.env`: this file contains properties to be used when creating the TD backend container and related to: + - the information required to connect to the MySQL DB. + - Some URL-s of the Identity Server (keycloak) to connect to. + - The main URL of the Service Catalogue HTTP API. + - The main URL of the UsageControl HTTP API. + + +### Start containers Create and start the containers specified in the docker-compose.yml file: ``` bash