CKB Explorer

CKB Explorer is a Nervos CKB blockchain explorer built with React and Ruby on Rails and includes two parts: CKB Explorer Frontend and CKB Explorer Server.

See live at CKB Explorer.

API documentation is available here.

CKB Explorer Frontend

Features

Explore blocks, transactions, addresses and lock hashes
Shows previous output and spending transaction details
Quick-search for tx hash, address, lock hash, block hash or height
Mobile-ready responsive design
Translated to two languages (English and Chinese)
Mainnet and Testnet with different theme colors

Getting Started

Prerequisite

Node: install version 12.0.0 or greater.
Yarn: See Yarn website for installation instructions. (needs 1.13.0 or greater).
A fork of the repo (for any contributions).
A clone of the ckb-explorer-frontend repo.

Edit .env file

You need to edit .env.develop for development and .env.production for production to set your own api url as ckb explorer server.

REACT_APP_API_URL = 'http://your-api-url'        # Set your own server api url

REACT_APP_CHAIN_TYPE = 'testnet'                 # Set chain type (mainnet or testnet)

REACT_APP_MAINNET_URL = 'http://localhost:3000'  # MAINNET_URL is for deploying testnet, please ignore for development

REACT_APP_TESTNET_NAME = 'testnet'               # TESTNET_NAME will be displayed on explorer header and it also determines the subpath of the testnet

Installation

git clone https://github.com/nervosnetwork/ckb-explorer-frontend.git
cd ckb-explorer-frontend
yarn install   # install dependency libraries

Running locally

yarn start to start the development server (or npm start, if not using Yarn).
open http://localhost:3000/ to open the site in your favorite browser.

Building production

yarn build    # build ckb explorer frontend project
yarn test     # run project test cases

Running with Docker

// Build and tag the Docker image
docker build -t explorer/dev . 

// Then, spin up the container once the build is done
docker run \                                                                                                                                               1m 48s 17:36:22
    -it \
    --rm \
    -v ${PWD}:/app \
    -v /app/node_modules \
    -p 3001:3000 \
    -e CHOKIDAR_USEPOLLING=true \
    explorer/dev

Open your browser to http://localhost:3001/ and you should see the app

Running with Docker Compose

docker-compose up -d --build

Open your browser to http://localhost:3001/ and you should see the app

Ensure the app is running in the browser and test hot-reloading again. Bring down the container before moving on:

docker-compose stop

Building production with Docker

Using the production Dockerfile, build and tag the Docker image:

docker build -f Dockerfile.prod -t explorer:prod .

Spin up the container:

docker run -it --rm -p 1337:80 explorer:prod

Navigate to http://localhost:1337/ in your browser to view the app.

Building production with Docker Compose

docker-compose -f docker-compose.prod.yml up -d --build