zoobc-explorer-ui: A JavaScript repository from ZooBC

A webview for searching and displaying data published, so that a user can easily find any info about blockchain.

👉 Installation

Fork and clone the Explorer repository then create your branch from develop on terminal.

  $ git clone https://github.com/your-github-account/zoobc-explorer-ui.git
  # press Enter then your local clone will be created

  $ cd zoobc-explorer-ui
  # access 'zoobc-explorer-ui' directory

Next, setup dependencies and globally installed for Node

  $ node -v
  # check Node version

  $ npm -v
  # check npm version

  $ ./language.sh
  # update submodule (language files)

  $ npm install
  # install node_modules packages

  $ npm run start
  # running localhost server
  # Local: http://localhost:3000/

  $ npm run test
  # running testing code

  $ npm run build
  # create production build

Ways to Contribute 👏

Contributing code 🔥

Code level contribute in Explorer generally come in the form of pull requests (PRs). The process of proposing some changes to Explorer can be summarized as follows:

Fork and clone this repository then create your branch from develop.
Please use the default title below if you want to create a new PRs from updated develop branch :
- If your task is a feature category, [EXP-<number_of_your_pull>][FEATURE] Title of your PRs.
- If your task is a enhance category, [EXP-<number_of_your_pull>][ENHANCE] Title of your PRs.
- If your task is a bugs category, [EXP-<number_of_your_pull>][BUGS] Title of your PRs.
Push your PRs changes to remote origin on https://github.com/zoobc/zoobc-explorer-ui
Please tag Reviewers, Assignees, Labels, and Projects.
Add some descriptions about your PRs info with describe the feature/enhance/bugs clearly and concise description of what is and include code sample, screenshoot or videos id needed. If all goes well, your PRs will be merges. If it is not merge, administrator will do their best to explain in the reason why.

Reviewing PRs 👌

So you have found a PR that you feel confident reviewing. Please make use of the GitHub Review feature, and clearly and politely communicate any suggestion.