Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/colored-coins/colored-coins-block-explorer
An implementation of a full Bitcoin Block Explorer (Parser/API/Sockets) with full Colored-Coins capabilities
https://github.com/colored-coins/colored-coins-block-explorer
Last synced: 2 months ago
JSON representation
An implementation of a full Bitcoin Block Explorer (Parser/API/Sockets) with full Colored-Coins capabilities
- Host: GitHub
- URL: https://github.com/colored-coins/colored-coins-block-explorer
- Owner: Colored-Coins
- Created: 2015-09-09T10:48:58.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-09-13T08:35:48.000Z (over 7 years ago)
- Last Synced: 2024-11-16T06:34:06.346Z (3 months ago)
- Language: JavaScript
- Size: 238 KB
- Stars: 17
- Watchers: 13
- Forks: 30
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Colored Coins Block-Explorer
[![Build Status][travis-image]][travis-url] [![Coverage percentage][coveralls-image]][coveralls-url] [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Slack Channel][slack-image]][slack-url]
[![js-standard-style][js-standard-image]][js-standard-url]
> The ColoredCoins Block Explorer server
### System Requirements
1. Bitcoind that runs as an RPC server with txindex=1
2. Mongodb
3. At least a 1.5TB hard-drive (The current size of the data is around 1TB, as of November 2016)
### Installation
```sh
$ npm i -g cc-block-explorer
```
### Run
You can run the Block Explorer with the following options:
```sh
cc-explorer [options]
Options:
-h, --help output usage information
-V, --version output the version number
-p, --port Port to listen on [$PORT or 8080/8081]
-s, --ssl Enable ssl
-c, --conf Load a custom configuration file
```
Or just run it with the defaults using:
```sh
$ cc-explorer
```
### Properties
#### The propeties to provide:
- Empty uncommented properites are MANDATORY
- Commented properties are OPTIONAL
- Non empty uncommented properties are the DEFAULT values but can be changed if wanted
```ini
[ENV]
type=production (you can switch between development/QA/production)
#The most basic HTTP server settings, must at least contain the port value
[server]
https_port=8081
http_port=8080
cookies_secret=1234
sockets=true
favicon=app/public/favicon.ico
name=blockexplorer
cluster=0
#SSL settings. Decomment the next lines to use SSL
[ssl]
#key=
#crt=
#mongoDB settings. Decomment the next lines to use it
[db]
host=localhost
port=27000
name=explorer
dir=db/
#user=
#pass=
#Your Bitcoind server settings
[bitcoin_rpc]
ssl=false
url=localhost
path=
username=rpcuser
password=rpcpassword
port=8332
timeout=30000
#Continue scanning and parsing new transaction or just be in API mode
[scanner]
scan=true
mempool=true
mempool_only=false
#Basic HTTP authentication to lock website
[basic]
#admin_users=
#realm=
#Logger properties
[log]
#logentries_api_key=
#level=
```
### Developmenet
1. Fork this repo
2. npm install
3. use the Standard coding style when hacking the code - https://github.com/feross/standard
4. Send us a pull request
## License
[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
[js-standard-url]: https://github.com/feross/standard
[js-standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
[npm-image]: https://badge.fury.io/js/cc-block-explorer.svg
[npm-url]: https://npmjs.org/package/cc-block-explorer
[travis-image]: https://travis-ci.org/Colored-Coins/Colored-Coins-Block-Explorer.svg?branch=master
[travis-url]: https://travis-ci.org/Colored-Coins/Colored-Coins-Block-Explorer
[daviddm-image]: https://david-dm.org/Colored-Coins/Colored-Coins-Block-Explorer.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/Colored-Coins/Colored-Coins-Block-Explorer
[coveralls-image]: https://coveralls.io/repos/Colored-Coins/Colored-Coins-Block-Explorer/badge.svg
[coveralls-url]: https://coveralls.io/r//Colored-Coins/Colored-Coins-Block-Explorer
[slack-image]: http://slack.coloredcoins.org/badge.svg
[slack-url]: http://slack.coloredcoins.org
[mocha]: https://www.npmjs.com/package/mocha
[gulp]: http://gulpjs.com/