Merge pull request #120 from martindale/easy-install
Update Documentation
This commit is contained in:
commit
92cf429e64
|
@ -22,7 +22,7 @@ module.exports = function(grunt) {
|
|||
},
|
||||
},
|
||||
js: {
|
||||
files: ['Gruntfile.js', 'server.js', 'app/**/*.js', 'public/js/**'],
|
||||
files: ['Gruntfile.js', 'insight.js', 'app/**/*.js', 'public/js/**'],
|
||||
tasks: ['jshint'],
|
||||
options: {
|
||||
livereload: true,
|
||||
|
@ -48,7 +48,7 @@ module.exports = function(grunt) {
|
|||
},
|
||||
jshint: {
|
||||
all: {
|
||||
src: ['Gruntfile.js', 'server.js', 'app/**/*.js', 'public/js/**','lib/*.js'],
|
||||
src: ['Gruntfile.js', 'insight.js', 'app/**/*.js', 'public/js/**','lib/*.js'],
|
||||
options: {
|
||||
jshintrc: true
|
||||
}
|
||||
|
@ -63,7 +63,7 @@ module.exports = function(grunt) {
|
|||
|
||||
nodemon: {
|
||||
dev: {
|
||||
script: 'server.js',
|
||||
script: 'insight.js',
|
||||
options: {
|
||||
args: [],
|
||||
ignore: ['public/**', 'test/**','util/**'],
|
||||
|
|
17
README.md
17
README.md
|
@ -3,8 +3,9 @@
|
|||
Project description.
|
||||
|
||||
## 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).
|
||||
* 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
|
||||
* 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:
|
||||
|
||||
$ git clone git@github.com:<your_username>/insight.git
|
||||
|
||||
$ cd myster
|
||||
$ git clone git@github.com:<your_username>/insight.git && cd insight
|
||||
|
||||
Install Grunt Command Line Interface:
|
||||
|
||||
|
@ -41,6 +40,7 @@ $ npm install -g bower
|
|||
Install dependencies:
|
||||
|
||||
$ npm install
|
||||
$ bower install
|
||||
|
||||
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
|
||||
|
||||
|
||||
### Development enviroment
|
||||
### Development environment
|
||||
To run insight locally for development:
|
||||
|
||||
$ 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
|
||||
[Insight](https://github.com/bitpay/insight)
|
||||
|
||||
|
|
|
@ -13,7 +13,7 @@ module.exports = {
|
|||
port: process.env.BITCOIND_PORT || '18332',
|
||||
disableAgent: true,
|
||||
},
|
||||
network: 'testnet',
|
||||
network: process.env.INSIGHT_NETWORK || 'testnet',
|
||||
disableP2pSync: false,
|
||||
disableHistoricSync: false,
|
||||
};
|
||||
|
|
Loading…
Reference in New Issue