Skip to content

Commit

Permalink
editing compose and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
costero-e committed Dec 22, 2023
1 parent 77e7600 commit 0fa5cd0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,29 @@
Instructions on how to deploy the Beacon Network User Interface
## 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:

```bash
REACT_APP_CLIENT_ID="ID of your LS Login"
REACT_APP_CLIENT_SECRET="password of your LS Login"
```

Take into account that the above file will not be copied to GitHub as it contains keys and for security reasons it should ignored.

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:
After that please proceed to execute the next command in order to deploy the UI.

```bash
docker-compose up -d –build
```

Then please edit the file config.json, which can be found inside folder [frontend/src](https://github.com/elixir-europe/beacon-network-ui/tree/main/frontend/src). You need to decide where you want the UI to point to when making requests. Find below an example:

```bash
{
"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.
5 changes: 4 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,7 @@ services:
- CHOKIDAR_USEPOLLING=true
ports:
- 3000:3000
stdin_open: true
stdin_open: true
volumes:
- ./frontend/.env:/frontend/.env
- ./frontend/src/config.json:/frontend/src/config.json

0 comments on commit 0fa5cd0

Please sign in to comment.