Git Product home page Git Product logo

ckb-explorer's Introduction

About CKB

CKB is the layer 1 of Nervos Network, a public/permissionless blockchain. CKB uses Proof of Work and improved Nakamoto concensus to achieve maximized performance on average hardware and internet condition, without sacrificing decentralization and security which are the core value of blockchain.

CKB Explorer

CKB Explorer is a Nervos CKB blockchain explorer built with React and Ruby on Rails.

It supports searching block, transaction, address and includes two parts: frontend and backend server.

CKB Explorer Server

License TravisCI Codecov Telegram Group

A blockchain explorer cache server of Nervos CKB.

Prerequisites

  $ git clone https://github.com/bitcoin-core/secp256k1.git && cd secp256k1 && ./autogen.sh && ./configure --enable-module-recovery --enable-experimental --enable-module-ecdh && make && sudo make install && cd ..

Optional prerequisites

If you want to contribute to the API documentation you need to install raml2html to generate HTML documentation.

Initial Project

$ cd ckb-explorer/
$ touch .env.local (overwrite `.env` config if you need in `.env.local`, such as DB_USERNAME, DB_PASSWORD...)
$ touch config/settings.local.yml (overwrite `config/settings.yml` to config available hosts)
$ bin/setup

Running Test

$ bundle exec rails test

Run Project

$ bundle exec rails s

# start sync process
$ ruby lib/ckb_block_node_processor.rb

Deploy

You can deploy this via mina

$ mina setup
$ mina staging deploy

How to Contribute

CKB Explorer Server is an open source project and your contribution is very much appreciated. Please check out CONTRIBUTING.md for guidelines about how to proceed.

Build API Documentation

$ cd ckb-explorer
$ raml2html doc/api.raml > public/api_doc.html

API Documentation

Please see this Documentation.

License

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

ckb-explorer's People

Contributors

shaojunda avatar duanyytop avatar classicalliu avatar wuyuyue avatar dependabot[bot] avatar quake avatar mine77 avatar ashchan avatar keith-cy avatar marshluca avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.