Merge pull request #120 from martindale/easy-install

Update Documentation
This commit is contained in:
Matias Alejo Garcia 2014-01-21 17:29:24 -08:00
commit 92cf429e64
4 changed files with 16 additions and 9 deletions

View File

@ -22,7 +22,7 @@ module.exports = function(grunt) {
}, },
}, },
js: { js: {
files: ['Gruntfile.js', 'server.js', 'app/**/*.js', 'public/js/**'], files: ['Gruntfile.js', 'insight.js', 'app/**/*.js', 'public/js/**'],
tasks: ['jshint'], tasks: ['jshint'],
options: { options: {
livereload: true, livereload: true,
@ -48,7 +48,7 @@ module.exports = function(grunt) {
}, },
jshint: { jshint: {
all: { all: {
src: ['Gruntfile.js', 'server.js', 'app/**/*.js', 'public/js/**','lib/*.js'], src: ['Gruntfile.js', 'insight.js', 'app/**/*.js', 'public/js/**','lib/*.js'],
options: { options: {
jshintrc: true jshintrc: true
} }
@ -63,7 +63,7 @@ module.exports = function(grunt) {
nodemon: { nodemon: {
dev: { dev: {
script: 'server.js', script: 'insight.js',
options: { options: {
args: [], args: [],
ignore: ['public/**', 'test/**','util/**'], ignore: ['public/**', 'test/**','util/**'],

View File

@ -3,8 +3,9 @@
Project description. Project description.
## Prerequisites ## Prerequisites
* Node.js - Download and Install [Node.js](http://www.nodejs.org/download/). You can also follow [this gist](https://gist.github.com/isaacs/579814) for a quick and easy way to install Node.js and npm * Node.js v0.10.x - Download and Install [Node.js](http://www.nodejs.org/download/). You can also follow [this gist](https://gist.github.com/isaacs/579814) for a quick and easy way to install Node.js and npm, or the Ubuntu way: git clone git@github.com:joyent/node.git && cd node && git checkout v0.10.24 && ./configure && make && make install`
* MongoDB - Download and Install [MongoDB](http://www.mongodb.org/downloads) - Make sure it's running on the default port (27017). * MongoDB - Download and Install [MongoDB](http://www.mongodb.org/downloads) - Make sure it's running on the default port (27017).
* Bitcoind - Download and Install [Bitcoin](http://bitcoin.org/en/download) - You should make sure to configure RPC security and `txindex`. For an example, see `./etc/bitcoind/bitcoin.conf`
### Tools Prerequisites ### Tools Prerequisites
* NPM - Node.js package manager, should be installed when you install node.js. * NPM - Node.js package manager, should be installed when you install node.js.
@ -30,9 +31,7 @@ $ npm install -g bower
Then clone it wherever you want: Then clone it wherever you want:
$ git clone git@github.com:<your_username>/insight.git $ git clone git@github.com:<your_username>/insight.git && cd insight
$ cd myster
Install Grunt Command Line Interface: Install Grunt Command Line Interface:
@ -41,6 +40,7 @@ $ npm install -g bower
Install dependencies: Install dependencies:
$ npm install $ npm install
$ bower install
We use [Grunt](https://github.com/gruntjs/grunt-cli) to start the server: We use [Grunt](https://github.com/gruntjs/grunt-cli) to start the server:
@ -185,12 +185,19 @@ If you are using node instead of grunt, it is very similar:
$ NODE_ENV=test node server $ NODE_ENV=test node server
### Development enviroment ### Development environment
To run insight locally for development: To run insight locally for development:
$ NODE_ENV=development grunt $ NODE_ENV=development grunt
### Production
You can use [pm2](https://github.com/Unitech/pm2) to manage NodeJS in production:
$ npm install pm2 -g
$ pm2 start insight.js
## Github ## Github
[Insight](https://github.com/bitpay/insight) [Insight](https://github.com/bitpay/insight)

View File

@ -13,7 +13,7 @@ module.exports = {
port: process.env.BITCOIND_PORT || '18332', port: process.env.BITCOIND_PORT || '18332',
disableAgent: true, disableAgent: true,
}, },
network: 'testnet', network: process.env.INSIGHT_NETWORK || 'testnet',
disableP2pSync: false, disableP2pSync: false,
disableHistoricSync: false, disableHistoricSync: false,
}; };