erigon-pulse/debug-web-ui/README.md

79 lines
2.4 KiB
Markdown
Raw Normal View History

2020-02-09 10:31:52 +00:00
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Prerequisites
- Node.js v13 or higher
2020-02-09 10:31:52 +00:00
- yarn (install with `npm install -g yarn`)
2020-02-09 10:31:52 +00:00
## Quickstart
1. Install dependencies: `cd debug-web-ui && yarn install && cd ..`
2020-02-09 10:31:52 +00:00
2. Run TurboGeth with the RemoteDB interface: `./build/bin/tg --private.api.addr=localhost:9090`
2020-02-09 10:31:52 +00:00
3. Run the rest server: `make restapi && ./build/bin/restapi`
4. Run the web UI: `make run-web-ui`
## Auto-Format code on save:
For Webstorm: https://blog.jetbrains.com/webstorm/2020/02/webstorm-2020-1-eap-5/
2020-02-09 10:31:52 +00:00
## Available Scripts
In the project directory, you can run:
### `yarn start`
Runs the app in the development mode.<br />
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
The page will reload if you make edits.<br />
You will also see any lint errors in the console.
### `yarn test`
Launches the test runner in the interactive watch mode.<br />
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.<br />
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.<br />
Your app is ready to be deployed!
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
## 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
### Analyzing the Bundle Size
This section has moved here: 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
### Advanced Configuration
This section has moved here: 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
### `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