From 89086bcbabbc6e4f94d9212b50685d3f2c23943e Mon Sep 17 00:00:00 2001
From: Idoia Murua <idoia.murua@tecnalia.com>
Date: Fri, 26 Apr 2024 11:05:52 +0200
Subject: [PATCH] README initialization

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 8072bd0..996ad38 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
-- 
GitLab