Skip to content

Commit

Permalink
Edit Sui Explorer README, link to DevNet guide for use (MystenLabs#1816)
Browse files Browse the repository at this point in the history
  • Loading branch information
Clay-Mysten authored May 5, 2022
1 parent 372c997 commit 3f300f0
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions explorer/client/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Sui Explorer Frontend

Sui Explorer 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.
[Sui Explorer](https://explorer.devnet.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 14.0.0 or later version
**Requirements**: Node 14.0.0 or later.

Currently the Explorer depends on an unreleased version of `sui.js`, the TypeScript SDK for SUI. Therefore, you need to build the SDK first:
Currently the Explorer depends on an unreleased version of `sui.js`, the TypeScript SDK for Sui. Therefore, you need to build the SDK first:

```bash
$ cd <Your Sui Repository>/sdk/typescript
Expand All @@ -19,7 +19,7 @@ Then, in the project directory, run:
$ yarn
```

NOTE: If you are updating the SDK and Explorer at the same time, you need to run the following command to make sure the explorer depends on the updated SDK
> **Note:** If you are updating the SDK and Explorer at the same time, you need to run the following commands to make sure the Explorer depends on the updated SDK.
```bash
$ cd <Your Sui Repository>/sdk/typescript
Expand All @@ -35,16 +35,16 @@ Before running any of the following scripts `yarn` must run in order to install

## Connecting to Remote Gateway server(e.g., DevNet)

The Sui Explorer frontend will use the DevNet Gateway server by default: https://https://explorer.devnet.sui.io.
The Sui Explorer frontend will use the DevNet Gateway server by default: https://explorer.devnet.sui.io

```bash
yarn start

```

## Connecting to local RPC Server
## Connecting to local RPC server

Please refer to [this guide](../../doc/src/build/json-rpc.md) on setting up a local RPC Server
Refer to [Local RPC Server & JSON-RPC API Quick Start](../../doc/src/build/json-rpc.md) on setting up a local RPC Server

```bash
yarn start:local
Expand All @@ -61,7 +61,7 @@ For example, suppose we wish to locally run the website using the static JSON da
yarn start:static
```

# Other Yarn Commands
# Other Yarn commands

### `yarn test`

Expand Down Expand Up @@ -90,3 +90,5 @@ Currently the Explorer supports
- Object details page
- Address page with owned objects
- Search for transactions, addresses, and Objects by ID

See [Experiment with Sui DevNet](https://docs.sui.io/explore/devnet) for use.

0 comments on commit 3f300f0

Please sign in to comment.