Go to file
Gustavo Cortez 87dd9a7159 fix navbar. hide status if screen is small 2014-03-17 15:18:11 -03:00
public fix navbar. hide status if screen is small 2014-03-17 15:18:11 -03:00
.bowerrc bootstrap ready! 2014-01-06 16:12:14 -03:00
.gitignore update 2014-02-24 11:17:46 -03:00
.jshintrc handle_inv tests 2014-01-16 16:12:32 -03:00
Gruntfile.js added a new way to scan qr codes from mobile browsers 2014-03-08 03:23:42 -03:00
README.md Update README.md 2014-02-28 19:10:04 -02:00
bower.json adde angular-ui-utils. CSS fix 2014-02-28 17:22:24 -03:00
package.json change insight-api dep to github 2014-03-10 16:48:05 -03:00

README.md

insight

insight is an open-source bitcoin blockchain explorer with complete REST and websocket APIs. Insight runs in NodeJS, uses AngularJS for the front-end and LevelDB for storage.

Check some screenshots and more details at insight's project homepage.

Insight project is now splitted in two repositories. One for the API and for the front-end. This repository is for the front-end, which will install the API as a NPM dependency.

Prerequisites

  • Node.js v0.10.x - Download and Install Node.js.

  • NPM - Node.js package manager, should be automatically installed when you get node.js.

Quick Install

Check the Prerequisites section above before installing.

To install Insight, clone the main repository:

$ git clone git@github.com:bitpay/insight.git && cd insight

Install dependencies:

$ npm install

Run the main application:

$ npm start

Or just run:

$ INSIGHT_PUBLIC_PATH=public node node_modules/insight-bitcore-api/insight.js

Then open a browser and go to:

http://localhost:3001

Please note that the app will need to sync its internal database with the blockchain state, which may take some time. You can check sync progress from within the web interface.

Development

To run insight locally for development mode:

Install bower dependencies:

$ bower install

To compile and minify the web application's assets:

$ grunt compile

Note

For more details about the insight API configs and end-poinst, just go to insight API github repository or read the documentation

Contribute

Contributions and suggestions are welcomed at insight github repository.

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.