github.com/corverroos/quorum@v21.1.0+incompatible/dashboard/README.md (about)

     1  ## Go Ethereum Dashboard
     2  
     3  The dashboard is a data visualizer integrated into geth, intended to collect and visualize useful information of an Ethereum node. It consists of two parts:
     4  
     5  * The client visualizes the collected data.
     6  * The server collects the data, and updates the clients.
     7  
     8  The client's UI uses [React][React] with JSX syntax, which is validated by the [ESLint][ESLint] linter mostly according to the [Airbnb React/JSX Style Guide][Airbnb]. The style is defined in the `.eslintrc` configuration file. The resources are bundled into a single `bundle.js` file using [Webpack][Webpack], which relies on the `webpack.config.js`. The bundled file is referenced from `dashboard.html` and takes part in the `assets.go` too. The necessary dependencies for the module bundler are gathered by [Node.js][Node.js].
     9  
    10  ### Development and bundling
    11  
    12  As the dashboard depends on certain NPM packages (which are not included in the `go-ethereum` repo), these need to be installed first:
    13  
    14  ```
    15  $ (cd dashboard/assets && yarn install && yarn flow)
    16  ```
    17  
    18  Normally the dashboard assets are bundled into Geth via `go-bindata` to avoid external dependencies. Rebuilding Geth after each UI modification however is not feasible from a developer perspective. Instead, we can run `yarn dev` to watch for file system changes and refresh the browser automatically.
    19  
    20  ```
    21  $ geth --dashboard --vmodule=dashboard=5
    22  $ (cd dashboard/assets && yarn dev)
    23  ```
    24  
    25  To bundle up the final UI into Geth, run `go generate`:
    26  
    27  ```
    28  $ (cd dashboard && go generate)
    29  ```
    30  
    31  ### Static type checking
    32  
    33  Since JavaScript doesn't provide type safety, [Flow][Flow] is used to check types. These are only useful during development, so at the end of the process Babel will strip them.
    34  
    35  To take advantage of static type checking, your IDE needs to be prepared for it. In case of [Atom][Atom] a configuration guide can be found [here][Atom config]: Install the [Nuclide][Nuclide] package for Flow support, making sure it installs all of its support packages by enabling `Install Recommended Packages on Startup`, and set the path of the `flow-bin` which were installed previously by `yarn`.
    36  
    37  For more IDE support install the `linter-eslint` package too, which finds the `.eslintrc` file, and provides real-time linting. Atom warns, that these two packages are incompatible, but they seem to work well together. For third-party library errors and auto-completion [flow-typed][flow-typed] is used.
    38  
    39  ### Have fun
    40  
    41  [Webpack][Webpack] offers handy tools for visualizing the bundle's dependency tree and space usage.
    42  
    43  * Generate the bundle's profile running `yarn stats`
    44  * For the _dependency tree_ go to [Webpack Analyze][WA], and import `stats.json`
    45  * For the _space usage_ go to [Webpack Visualizer][WV], and import `stats.json`
    46  
    47  [React]: https://reactjs.org/
    48  [ESLint]: https://eslint.org/
    49  [Airbnb]: https://github.com/airbnb/javascript/tree/master/react
    50  [Webpack]: https://webpack.github.io/
    51  [WA]: https://webpack.github.io/analyse/
    52  [WV]: https://chrisbateman.github.io/webpack-visualizer/
    53  [Node.js]: https://nodejs.org/en/
    54  [Flow]: https://flow.org/
    55  [Atom]: https://atom.io/
    56  [Atom config]: https://medium.com/@fastphrase/integrating-flow-into-a-react-project-fbbc2f130eed
    57  [Nuclide]: https://nuclide.io/docs/quick-start/getting-started/
    58  [flow-typed]: https://github.com/flowtype/flow-typed