kef / block_browser Goto Github PK

== BlockBrowser

This application lets you browse the bitcoin blockchain using bitcoin-ruby.

It is highly experimental, use at your own risk.

== Requirements

* ruby 1.9.3
* rubygems, bundler
* rails 3.1.3
* bitcoin-ruby
* database adapter

== Setup

You need blockchain database built by bitcoin-ruby.

Create `config/application.yml` to point to the database and set the network,
websocket url and bitcoin command socket:

 network: bitcoin
 database: dummy
 # database: sequel::sqlite:/
 # database: sequel::postgres:/bitcoin
 domain: example.com
 donate: "19Ks8ikpVdLR5zfLSh8Krbg8duNYmDc3T3" # my address :P
 websocket: "127.0.0.1:8000"
 command: "127.0.0.1:9999"

Also, add the corresponding db library to the `Gemfile`:

 # gem 'sequel'
 # gem 'sqlite3'
 # gem 'pg'

Then install the required gems

 bundle install

And start the server

 rails s

And the websocket server

 rails runner lib/websocket.rb

== License

This software is released under the terms of the GNU Affero General Public License, version 3. See COPYING for more information or see http://www.gnu.org/licenses/.