iotex-explorer

iotex-explorer is a frontend website for iotex-core blockchain.

Check our site hosted at https://iotexscan.io.

Or deploy your own instance on Heroku.

Getting Started

git clone git@github.com:iotexproject/iotex-explorer.git

Run your project

This is intended for *nix users. If you use Windows, go to Run on Windows. Let's first prepare the environment.

cd iotex-explorer

nvm use 10.15.0
npm install

# prepare environment variable
cp ./.env.tmpl ./.env

Note: please provide your iotex-core URL like IOTEX_CORE=http://api.mainnet.iotex.one:80 in ./.env file.

Built with OneFx (React, GraphQL, KOA, TypeScript, AVA, Webpack, etc.)

• Documentation
• Contributing

Development mode

To run your project in development mode, run:

npm run watch

The development site will be available at http://localhost:4004.

Production Mode

It's sometimes useful to run a project in production mode, for example, to check bundle size or to debug a production-only issue. To run your project in production mode locally, run:

npm run build-production
NODE_ENV=production npm run start

Debugging Enterprise Mode

NODE_CONFIG_ENV=enterprise npm run watch

And then visit http://localhost:4004/?locale=zh-CN

NPM scripts

• npm run test: test the whole project and generate a test coverage
• npm run ava ./path/to/test-file.js: run a specific test file
• npm run build: build source code from src to dist
• npm run lint: run the linter
• npm run kill: kill the node server occupying the port 4004.

Contribute to Localization?

Join here to contribute: https://lokalise.co/public/903185115c91ceff0cb2a0.70666943/

How to add meta for an address?

• Fork this repo to your own.
• Modify src/api-gateway/address-meta.json by append you entry to the json list.
  • Your entry should be follow struct as below

    {
      "address": "<your address>",
      "name": "<your address's name>"
    }
    

    Ex:

    {
      "address": "io1et7zkzc76m9twa4gn5xht3urt9mwj05qvdtj66",
      "name": "iotxplorerio"
    }
    

• Commit & push your changes to your git repo.
• Send a PR with title prefix [ADDRESS-META] and description of your address if you want to merge into our repo.