README initialization

README.md

+# User Journey Services Engine
+
+The Transparency Dashboard (TD) can be installed via docker compose. The composition includes:
+- A MySQL database.
+- The TD backend, with its HTTP API.
+- The TD frontend, and angular application.
+
+The HTTP API offered by the TD backend is specified [here](./td_openapi.yaml).
+
+## Installation requirements
+TD requires the following ACROSS components to be already installed:
+
+- [Usage Control](https://git.code.tecnalia.com/across/public/citizen-data-ownership-and-usage-control/usage-control/Usagecontrol): to do the enforcement of the usage policies defined by the citizen
+- [Service Catalogue](https://git.code.tecnalia.com/across/public/data-harmonization-and-connectors/service-registry/Public_Service_Catalog_ENG)
+- An Identity Server, as Keycloak, installed and configured with its corresponding realm and clients.
+
+To install the project, you need to have Docker and Docker-compose installed on your machine. If you don't have it, you can install it by following the instructions on the official Docker website.
+
+
+## Identity Server configuration
+Two clients named `trans-db-be` and `trans-db-fe`, with the `citizen` role within the realm to be used for all the Across clients must be configured in the Identity Server.
+
+
+## Installation
+Clone this repository:
+
+``` bash
+git clone https://git.code.tecnalia.com/across/public/citizen-front-end/transparency-dashboard/transparency-dashboard-ui.git
+```
+
+Create and start the containers specified in the docker-compose.yml file:
+
+``` bash
+docker-compose up -d
+```
+
+## License
+
+Read the [license file](./LICENSE) for more information.
+