https://github.com/nervosnetwork/ckb-explorer-frontend

Nervos CKB Explorer Frontend
https://github.com/nervosnetwork/ckb-explorer-frontend

blockchain ckb css-in-js enzyme explorer jest react react-hooks responsive-design typescript

Last synced: about 1 month ago
JSON representation

Nervos CKB Explorer Frontend

• Host: GitHub
• URL: https://github.com/nervosnetwork/ckb-explorer-frontend
• Owner: nervosnetwork
• License: mit
• Created: 2019-06-15T09:52:17.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2024-04-13T14:45:54.000Z (10 months ago)
• Last Synced: 2024-04-14T04:27:58.286Z (10 months ago)
• Topics: blockchain, ckb, css-in-js, enzyme, explorer, jest, react, react-hooks, responsive-design, typescript
• Language: TypeScript
• Homepage: https://explorer.nervos.org/
• Size: 65.6 MB
• Stars: 107
• Watchers: 7
• Forks: 73
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        


CKB Explorer


[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/nervosnetwork/ckb-explorer-frontend/blob/develop/COPYING)

[![Github Actions CI](https://github.com/nervosnetwork/ckb-explorer-frontend/workflows/CI/badge.svg?branch=develop)](https://github.com/nervosnetwork/ckb-explorer-frontend/actions)

[![Discord](https://img.shields.io/discord/956765352514183188?label=Discord&logo=discord&style=default&color=grey&labelColor=5865F2&logoColor=white)](https://discord.gg/RsyKyejxAW)

CKB Explorer is a [Nervos CKB](https://github.com/nervosnetwork/ckb) blockchain explorer built with [React](https://reactjs.org/) and [Ruby on Rails](https://rubyonrails.org/) and includes two parts: [CKB Explorer Frontend](https://github.com/nervosnetwork/ckb-explorer-frontend) and [CKB Explorer Server](https://github.com/nervosnetwork/ckb-explorer).

See live at [CKB Explorer](https://explorer.nervos.org).

API documentation is [available here](https://nervosnetwork.github.io/ckb-explorer/public/api_doc.html).

# 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](https://yarnpkg.com/lang/en/docs/install/). (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.development for development and .env.production for production to set your own api url as ckb explorer server.

```shell

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

```shell

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

```shell

yarn build    # build ckb explorer frontend project

yarn test     # run project test cases

```

## License

CKB Explorer Frontend is released under the terms of the MIT license. See [COPYING](COPYING) for more information or see [https://opensource.org/licenses/MIT](https://opensource.org/licenses/MIT).