CKB Explorer

CKB Explorer is a blockchain explorer for Nervos CKB, built with modern web technologies. It consists of two parts:

• CKB Explorer Frontend (This repository)
• CKB Explorer Server

Visit the live explorer at explorer.nervos.org.

Features

• Blockchain Exploration

  • Browse blocks, transactions, addresses and lock hashes
  • Track transaction lifecycle and UTXO details
  • Advanced search functionality for various blockchain entities
  • Real-time updates and data synchronization

• Bitcoin Interoperability

  • Support for Bitcoin addresses and corresponding RGB++ transactions
  • Cross-chain transaction tracking
  • BTC-CKB leap monitoring

• Fiber Network Integration

  • Network statistics and metrics
  • Channel management and monitoring
  • Liquidity tracking and analysis

• User Experience

  • Responsive design for all devices
  • Multi-language support (English, Chinese)
  • Distinct themes for Mainnet and Testnet
  • Intuitive navigation and data visualization

Getting Started

Prerequisites

• Node.js v18.13.0 or later
• Yarn 1.13.0 or later
• Git

Installation

# Clone the repository
git clone https://github.com/nervosnetwork/ckb-explorer-frontend.git

# Navigate to project directory
cd ckb-explorer-frontend

# Install dependencies
yarn install

Configuration

Create or modify the environment files:

• .env.development for development
• .env.production for production

# Required environment variables
REACT_APP_API_URL='http://your-api-url'        # API endpoint
REACT_APP_CHAIN_TYPE='testnet'                 # 'mainnet' or 'testnet'
REACT_APP_MAINNET_URL='http://localhost:3000'  # Mainnet URL for testnet deployment
REACT_APP_TESTNET_NAME='testnet'               # Testnet name for header display

Development

# Start development server
yarn start

# Run tests
yarn test

# Build for production
yarn build

Project Structure

src/
├── components/      # Reusable UI components
├── pages/          # Page components
├── services/       # API and services
├── utils/          # Utility functions
├── hooks/          # Custom React hooks
├── assets/         # Static assets
├── routes/         # Route configuration
└── styles/         # Global styles

API Documentation

API documentation is available at CKB Explorer API Docs.

Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Community

• Join our Discord for discussions
• Follow us on Twitter
• Read our Documentation

License

CKB Explorer Frontend is released under the MIT License. See COPYING for more information or see https://opensource.org/licenses/MIT.