Skip to content

Latest commit

 

History

History
 
 

explorer

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 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.

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 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 and the LICENSES directory 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 and tag them with network-explorer.

Development

Please see development docs here for more information on the structure and design of this app.