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

Several environment variables are required. They can be
provisioned via a `.env` file. For convenience a `.env.dev` is
provided, just copy its content into `.env`.

#### Required env vars

```
EXPLORER_API_URL
NYM_API_URL
VALIDATOR_URL
BIG_DIPPER_URL
CURRENCY_DENOM
CURRENCY_STAKING_DENOM
```

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