Mark Sinclair
c66d7ed489
* Use new eslint rules and apply fixes. Use new logo component and shared theme + webpack config. * Add shared component to display a copy icon and copy to clipboard with confirmation state * Organise imports * Add copy mixnode identity key to list of mixnodes and detail view * Update nvm node version to 16 * Update GitHub Actions for Network Explorer to use yarn and yarn workspaces * Switch favicon for smaller N icon * Update README * Add error boundary
63 lines
1.5 KiB
Markdown
63 lines
1.5 KiB
Markdown
# Nym Network Explorer
|
|
|
|
The network explorer lets you explore the Nym network.
|
|
|
|
## Getting started
|
|
|
|
You will need:
|
|
|
|
- NodeJS (use `nvm install` to automatically install the correct version)
|
|
- `npm`
|
|
- `yarn`
|
|
|
|
> **Note**: This project ipart of a mono repo, so you will need to build the shared packages before starting. And any time they change, you'll need to rebuild them.
|
|
|
|
From the [root of the repository](../README.md) run the following to build shared packages:
|
|
|
|
```
|
|
yarn
|
|
yarn build
|
|
```
|
|
|
|
From the `explorer` directory of the `nym` monorepo, run:
|
|
|
|
```
|
|
cd explorer
|
|
yarn start
|
|
```
|
|
|
|
You can then open a browser to http://localhost:3000 and start development.
|
|
|
|
## Development
|
|
|
|
Documentation for developers [can be found here](./docs).
|
|
|
|
## Deployment
|
|
|
|
Build the UI with (starting in the repository root):
|
|
|
|
```
|
|
yarn
|
|
yarn build
|
|
cd explorer
|
|
yarn build
|
|
```
|
|
|
|
The output will be in the `dist` directory. Serve this with `nginx` or `httpd`.
|
|
|
|
Make sure you have built the [explorer-api](./explorer-api) and are running it as a service proxied through
|
|
`nginx` or `httpd` so that both the UI and API are running on the same host.
|
|
|
|
## License
|
|
|
|
Please see the [project README](./README.md) and the [LICENSES directory](../LICENSES) for license details for all Nym software.
|
|
|
|
## Contributing
|
|
|
|
If you would like to contribute to the Network Explorer send us a PR or
|
|
[raise an issue on GitHub](https://github.com/nymtech/nym/issues) and tag them with `network-explorer`.
|
|
|
|
## Development
|
|
|
|
Please see [development docs](./docs) here for more information on the structure and design of this app.
|