Mystery

Project description.

Prerequisites

• Node.js - Download and Install Node.js. You can also follow this gist for a quick and easy way to install Node.js and npm
• MongoDB - Download and Install MongoDB - Make sure it's running on the default port (27017).

Tools Prerequisites

• NPM - Node.js package manager, should be installed when you install node.js.
• Grunt - Download and Install Grunt.
• Bower - Web package manager, installing Bower is simple when you have npm:

$ npm install -g bower

Additional Packages

• Express - Defined as npm module in the package.json file.
• Mongoose - Defined as npm module in the package.json file.
• AngularJS - Defined as bower module in the bower.json file.
• Twitter Bootstrap - Defined as bower module in the bower.json file.
• UI Bootstrap - Defined as bower module in the bower.json file.

Quick Install

The quickest way to get started with MEAN is to clone the project and utilize it like this:

Grunt Command Line Interface:

$ sudo npm -g install grunt-cli

Install dependencies:

$ npm install

We use Grunt to start the server:

$ grunt

When not using grunt you can use (for example in production):

$ node server

Then open a browser and go to:

http://localhost:3000

API

A REST API is provided at /api. The entry points are:

Prerequisites

Get bitcore from github repository:

$ git clone https://github.com/bitpay/bitcore.git

$ cd bitcore

$ npm install

Then create a symbolic link from this to your mystery repository. We need to use bitcore from github, not with npm for now:

$ cd mystery/node_modules

$ rm -R bitcore

$ ln -s <path-to-your-clone-repositoy>/bitcore

Run sync from mystery repository (to save blocks in MongoDB):

$ utils/sync.js

Check utils/sync.js --help for options.

Blocks

  /api/block/[:hash]
  /api/block/00000000a967199a2fad0877433c93df785a8d8ce062e5f9b451cd1397bdbf62

Transactions

  /api/tx/[:txid]
  /api/tx/525de308971eabd941b139f46c7198b5af9479325c2395db7f2fb5ae8562556c

Troubleshooting

If you did not get all library during grunt command, please use the follow command:

$ bower install

Configuration

All configuration is specified in the config folder, particularly the config.js file and the env files. Here you will need to specify your application name and database name.

bitcoind

There is a bitcoind configuration sample at:

    etc/bitcoind/bitcoin.conf

If you want to use a external bitcoind server set BITCOIND_HOST / BITCOIND_PORT enviroment variables. Make sure that bitcoind is configured to accept incomming connections using 'rpcallowip' decribed in https://en.bitcoin.it/wiki/Running_Bitcoin.

Environmental Settings

There are three environments provided by default, development, test, and production. Each of these environments has the following configuration options:

• db - This is the name of the MongoDB database to use, and is set by default to mystery-dev for the development environment.
• app.name - This is the name of your app or website, and can be different for each environment. You can tell which environment you are running by looking at the TITLE attribute that your app generates.

To run with a different environment, just specify NODE_ENV as you call grunt:

$ NODE_ENV=test grunt

If you are using node instead of grunt, it is very similar:

$ NODE_ENV=test node server

Development enviroment

To run mystery locally for development:

$ NODE_ENV=development grunt

Github

Mystery

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.