Skip to content

Commit

Permalink
adding deployment instructions for frontend
Browse files Browse the repository at this point in the history
  • Loading branch information
costero-e committed Dec 22, 2023
1 parent e45ec29 commit 5dfeb2c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 70 deletions.
12 changes: 7 additions & 5 deletions deploy/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -171,14 +171,16 @@ services:
frontend:
build:
context: ../frontend
#command: ["yarn"]
#command: ["node", "/opt/yarn-v1.22.19/bin/yarn.js", "start" ]
command: yarn start
container_name: react
command: node /opt/yarn-v1.22.19/bin/yarn.js start
container_name: beacon-ui
environment:
- CHOKIDAR_USEPOLLING=true
ports:
- 3000:3000
stdin_open: true
volumes:
- ../frontend:/usr/src/app
- ./frontend/.env:/frontend/.env
- ./frontend/src/config.json:/frontend/src/config.json



81 changes: 16 additions & 65 deletions frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,70 +1,21 @@
# Getting Started with Create React App
## Instructions on how to deploy the Beacon Network User Interface


This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
Please first create a .env file inside the frontend folder so that you can modify some variables as follows:

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

In the project directory, you can run:
Take into account that the above file will not be copied to GitHub as it contains keys and for security reasons it should ignored.

### `yarn start`
Then please edit the file config.json, which can be found inside folder [frontend/src](https://github.com/EGA-archive/beacon2-ri-api/blob/develop/frontend/src/config.json). You need to decide where you want the UI to point to when making requests. Find below an example:

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in your browser.

The page will reload when you make changes.\
You may also see any lint errors in the console.

### `yarn test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `yarn build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `yarn eject`

**Note: this is a one-way operation. Once you `eject`, you can't go back!**

If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.

You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).

### Code Splitting

This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)

### Analyzing the Bundle Size

This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)

### Making a Progressive Web App

This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)

### Advanced Configuration

This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)

### Deployment

This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)

### `yarn build` fails to minify

This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
```bash
{
"API_URL": "https://yourAPIdomain.com/beacon-network/v2.0.0",
"REDIRECT_URL": "https://yourUIdomain.com",
"KEYCLOAK_URL": "https://yourKEYCLOAKdomain.com"
}
```

0 comments on commit 5dfeb2c

Please sign in to comment.