https://github.com/HNScan/HNScan

Developer-Focused Block Explorer for Handshake
https://github.com/HNScan/HNScan

blockexplorer handshake nodejs

Last synced: 3 months ago
JSON representation

Developer-Focused Block Explorer for Handshake

• Host: GitHub
• URL: https://github.com/HNScan/HNScan
• Owner: HNScan
• Created: 2018-10-30T04:18:08.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T02:12:39.000Z (about 2 years ago)
• Last Synced: 2024-07-29T18:43:53.529Z (6 months ago)
• Topics: blockexplorer, handshake, nodejs
• Language: JavaScript
• Homepage: https://HNScan.com
• Size: 12.9 MB
• Stars: 92
• Watchers: 7
• Forks: 29
• Open Issues: 84
• Metadata Files:
  • Readme: README.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# HNScan

An open source block explorer for Handshake - written in React with a plugin for HSD. The primary focus of this explorer is to aid developers while integrating Handshake into their applications. It is originally designed to be run locally and explore regtest or testnet networks.

## Getting Started

There are 2 ways in which you can interact with HNScan.

### 1. Local Install

After cloning this repository:

Running a local version of HNScan requires a handshake client in order to operate correctly. If you do not have a handshake client currently running on your machine, refer to the handshake docs to get one started - [Handshake Docs](https://handshake-org.github.io/api-docs/?shell--cli#introduction)

HNScan also requires a plugin for HSD to run. For full instructions see: https://github.com/HandshakeAlliance/hnscan-backend

```

# Install the dependencies

> yarn

# Run the localhost server

> yarn start

```

### 2. Hosted Website

Visit [HNScan](https://HNScan.com)

## Development

### Setup

The easiest way to develop on HNScan, both the frontend and the backend, is by using `yarn/npm link`. Inside of your hnscan-backend directory, run `yarn/npm link` and wait for the process to finish.

Once the linking process is complete, from your `hsd` folder, run `yarn/npm link hnscan`. This will now allow you run the hnscan plugin from a local install, and changes will be picked up on hsd restarts.

Lastly, run `./bin/hsd --index-tx=true --index-address=true --plugins=hnscan` from inside your hsd folder to complete the backend setup.

### Workflow

We use a Github Flow workflow on HNScan. All feature branches should be forked from master, and compared to master inside of a PR. HNScan is redeployed on every commit into master, so once a PR is merged it will be immediately deployed.

## License

This project is licensed under [MIT License](/LICENSE).