Create README.md

README.md

@@ -0,0 +1,22 @@
+Instructions on how to deploy the Beacon Network User Interface
+
+
+Please first create a .env file inside the frontend folder so that you can modify some variables as follows:
+
+REACT_APP_CLIENT_ID="ID of your LS Login"
+REACT_APP_CLIENT_SECRET="password of your LS Login"
+
+
+After that please proceed to execute the command docker-compose up -d –build in order to deploy the UI.
+
+Then please edit the file config.json, which can be found inside folder frontend/src. You need to decide where you want the UI to point to when making requests. Find below an example:
+
+{
+   "API_URL": "https://yourAPIdomain.com/beacon-network/v2.0.0",
+   "REDIRECT_URL": "https://yourUIdomain.com",
+   "KEYCLOAK_URL": "https://yourKEYCLOAKdomain.com"
+ }
+
+
+Please take into account that the above file will not be copied to Github as it contains keys and for security reasons it should ignored.
+In the root folder (frontend) you will find a file called .gitignore with the list of all files that need to be ignored.