Browse Source

updated readme with new screenshots (showing the new search functionality)

fix-133-memory-crash
Dan Janosik 8 years ago
parent
commit
15f1f8e13e
  1. 16
      README.md
  2. BIN
      public/img/screenshots/block.png
  3. BIN
      public/img/screenshots/blocks.png
  4. BIN
      public/img/screenshots/home.png
  5. BIN
      public/img/screenshots/transaction-raw.png
  6. BIN
      public/img/screenshots/transaction.png

16
README.md

@ -4,20 +4,23 @@
Simple, stateless Bitcoin blockchain explorer, via RPC. Build with Node.js, express, bootstrap-v4.
This tool is intended to be a simple, stateless, self-hosted explorer for the Bitcoin blockchain, driven by RPC calls to your own bitcoind node. Because it is stateless, it is easy to run but lacks some (many?) of the features of other explorers.
# Getting started
## Prerequisites
1. Install and run a `Full Node` - [instructions](https://bitcoin.org/en/full-node). Ensure that your node has full transaction indexing enabled (`txindex=1`) and the RPC server enabled (`server=1`).
1. Install and run a full, archiving node - [instructions](https://bitcoin.org/en/full-node). Ensure that your node has full transaction indexing enabled (`txindex=1`) and the RPC server enabled (`server=1`).
2. Synchronize your node with the Bitcoin network.
## Instructions
1. Clone this repo
2. `npm install` to install all required dependencies
3. `npm start` to start the local server
4. Navigate to http://127.0.0.1:3002/
5. Connect using the RPC credentials for your target bitcoin node
3. Optional: Uncomment the "bitcoind" section in [env.js](app/env.js) to automatically connect to the target node.
4. `npm start` to start the local server
5. Navigate to http://127.0.0.1:3002/
6. Connect using the RPC credentials for your target bitcoin node (if you didn't edit [env.js](app/env.js) in Step 3)
# Screenshots
@ -33,3 +36,8 @@ Simple, stateless Bitcoin blockchain explorer, via RPC. Build with Node.js, expr
### Transaction Details
# ![Connect](public/img/screenshots/transaction.png)
### Transaction, Raw JSON
# ![Connect](public/img/screenshots/transaction-raw.png)
### List of all Blocks
# ![Connect](public/img/screenshots/blocks.png)

BIN
public/img/screenshots/block.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 394 KiB

After

Width:  |  Height:  |  Size: 429 KiB

BIN
public/img/screenshots/blocks.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 397 KiB

BIN
public/img/screenshots/home.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 254 KiB

After

Width:  |  Height:  |  Size: 309 KiB

BIN
public/img/screenshots/transaction-raw.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 506 KiB

BIN
public/img/screenshots/transaction.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 362 KiB

After

Width:  |  Height:  |  Size: 440 KiB

Loading…
Cancel
Save