An open API service indexing awesome lists of open source software.

https://github.com/codechain-io/codechain-explorer

Block Explorer for CodeChain
https://github.com/codechain-io/codechain-explorer

blockchain codechain explorer

Last synced: 3 months ago
JSON representation

Block Explorer for CodeChain

Awesome Lists containing this project

README

          

# CodeChain Explorer [![Gitter](https://badges.gitter.im/CodeChain-io.svg)](https://gitter.im/CodeChain-io/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Build Status](https://travis-ci.org/CodeChain-io/codechain-explorer.svg?branch=master)](https://travis-ci.org/CodeChain-io/codechain-explorer)

CodeChain explorer is a simple, easy to use, open-source visualization tool for viewing activity on the underlying blockchain network.

## Table of Contents

- [Install](https://github.com/CodeChain-io/codechain-explorer#install)
- [Running for development](https://github.com/CodeChain-io/codechain-explorer#running-for-development)
- [Running for production](https://github.com/CodeChain-io/codechain-explorer#running-for-production)

## Install

### Download

Download CodeChain-explorer's code from the GitHub repository

```
# git clone git@github.com:kodebox-io/codechain-explorer.git
# cd codechain-explorer
```

### Install package

Use yarn package manager to install packages

```
# yarn install
```

## Before starting

### Dependency

- Get [CodeChain-indexer](https://github.com/CodeChain-io/codechain-indexer) ready for indexing block data and running the API server

### Running for development

-The explorer will run at http://localhost:3000

```
# yarn run start

// You can chage the port of test server and the host URL with environment variables.
# PORT=3000 REACT_APP_SERVER_HOST=http://127.0.0.1:8081 yarn run start
```

### Running for production

#### Build

Build CodeChain-explorer with the following script. You can get optimized and uglified build code. It will be located in the "/build" directory

```
# yarn run build
```

- You can change the server host using an environment variable

```
# REACT_APP_SERVER_HOST=http://127.0.0.1:8080 yarn run build
```

## Custom Configuration

### Build

| | Default | Options | Description |
| ----------------------------- | --------------------- | ------- | ------------------------------- |
| REACT_APP_SERVER_HOST | http://127.0.0.1:9001 | | |
| REACT_APP_URL | | | This is used for the open graph |
| REACT_APP_HEADER_TITLE | | | |
| REACT_APP_HEADER_SHORT_TITLE | | | |
| REACT_APP_OG_TITLE | | | |
| REACT_APP_OG_DESC | | | |
| REACT_APP_OG_IMAGE | | | |
| REACT_APP_GOOGLE_ANALYTICS_ID | | | |
| PUBLIC_URL | | | |