zhangqwesc / qtum-explorer

Explorer

A QTUM blockchain explorer web application service for Qtumcore Node using the QTUM API.

Getting Started

1. Install nvm https://github.com/creationix/nvm

   nvm i v6
   nvm use v6

2. Install mongo https://docs.mongodb.com/manual/tutorial/install-mongodb-on-ubuntu/

3. Install qtum-bitcore https://github.com/qtumproject/qtum-bitcore - with ZMQ !

   # with ZMQ
   sudo apt-get install libzmq3-dev 

4. Install qtumcore-node

   npm i https://github.com/qtumproject/qtumcore-node.git#master
   
   $(npm bin)/qtumcore-node create mynode
   
   cd mynode
   
   $(npm bin)/qtumcore-node install https://github.com/qtumproject/insight-api.git#master
   $(npm bin)/qtumcore-node install https://github.com/qtumproject/qtum-explorer.git#master

5. Edit qtumcore-node.json

   {
     "network": "livenet",
     "port": 3001,
     "services": [
       "qtumd",
       "qtum-insight-api",
       "qtum-explorer",
       "web"
     ],
     "servicesConfig": {
       "qtum-explorer": {
         "apiPrefix": "qtum-insight-api",
         "routePrefix": "qtum-explorer",
         "nodemapLink": "https://qtum.org/en/nodemap"
      },
      "qtum-insight-api": {
        "routePrefix": "qtum-insight-api",
        "rateLimiterOptions": {
          "whitelist": [
            "123.456.12.34",
            "::ffff:123.456.12.34"
          ],
          "whitelistLimit": 9999999,
          "limit": 200,
          "interval": 60000,
          "banInterval": 3600000
        },
         "db": {
           "host": "127.0.0.1",
           "port": "27017",
           "database": "qtum-api-livenet",
           "user": "",
           "password": ""
        },
         "erc20": {
           "updateFromBlockHeight": 0
         }
       },
       "qtumd": {
         "spawn": {
           "datadir": "/home/user/.qtum",
          "exec": "/home/user/qtum-bitcore/src/qtumd"
         }
       }
     }
   }
   

6. Edit qtum.conf

   server=1
   whitelist=127.0.0.1
   txindex=1
   addressindex=1
   timestampindex=1
   spentindex=1
   zmqpubrawtx=tcp://127.0.0.1:28332
   zmqpubhashblock=tcp://127.0.0.1:28332
   rpcallowip=127.0.0.1
   rpcuser=user
   rpcpassword=password
   rpcport=18332
   reindex=1
   gen=0
   addrindex=1
   logevents=1
   

7. Run Node

   $(npm bin)/qtumcore-node start
   

8. Open a web browser to http://localhost:3001/qtum-explorer or http://localhost:3001/qtum-insight-api

Development

To run Insight UI locally in development mode:

Install bower dependencies:

$ bower install

To compile and minify the web application's assets:

$ grunt compile

There is a convenient Gruntfile.js for automation during editing the code

$ grunt

Multilanguage support

Insight UI uses angular-gettext for multilanguage support.

To enable a text to be translated, add the translate directive to html tags. See more details here. Then, run:

grunt compile

This action will create a template.pot file in po/ folder. You can open it with some PO editor (Poedit). Read this guide to learn how to edit/update/import PO files from a generated POT file. PO file will be generated inside po/ folder.

If you make new changes, simply run grunt compile again to generate a new .pot template and the angular javascript js/translations.js. Then (if use Poedit), open .po file and choose update from POT File from Catalog menu.

Finally changes your default language from public/src/js/config

gettextCatalog.currentLanguage = 'es';

This line will take a look at any *.po files inside po/ folder, e.g. po/es.po, po/nl.po. After any change do not forget to run grunt compile.

Note

For more details about the QTUM API configuration and end-points, go to QTUM API.

Contribute

Contributions and suggestions are welcomed at the Explorer 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.