sui-explorer-local/apps/explorer/README.md

Local Sui Explorer

# Sui Explorer

[Sui Explorer](https://explorer.sui.io/) is a network explorer for the Sui network, similar in functionality to [Etherscan](https://etherscan.io/) or [Solana Explorer](https://explorer.solana.com/). Use Sui Explorer to see the latest transactions and objects.

# Set Up

**Requirements**: Node 18.0.0 or later.

Dependencies are managed using [`pnpm`](https://pnpm.io/). You can start by installing dependencies in the root of the Sui repository:

```bash
$ pnpm install
```

> All `pnpm` commands below are intended to be run in the root of the Sui repo.

## Developing the Sui Explorer

To start the explorer dev server, you can run the following command:

```bash
pnpm --filter explorer dev
```

This will start the dev server on port 3000, which should be accessible on http://localhost:3000/

## To run end-to-end localnet test

Start validators locally:

```bash
cargo run --bin sui-test-validator
```

In a a separate terminal, you can now run the end-to-end tests:

```bash
pnpm --filter explorer playwright test
```

# Other pnpm commands

### `pnpm --filter explorer test`

This runs a series of end-to-end browser tests using the website as connected to the static JSON dataset. This command is run by the GitHub checks. The tests must pass before merging a branch into main.

### `pnpm --filter explorer build`

Builds the app for production to the `build` folder.

It bundles React in production mode and optimizes the build for the best performance.

### `pnpm --filter explorer lint`

Run linting check (prettier/eslint).