search

Itheum / explorer-dapp

Itheum Explorer enables for the exploration of the Itheum protocol
GNU General Public License v3.0
452 stars 3 forks source link

readme

@itheum/explorer-dapp

Itheum Explorer the public explore the Itheum protocol components.

Build using the MultiversX dApp Template, built using React.js and Typescript. It's a basic implementation of @multiversx/sdk-dapp, providing the basics for MultiversX authentication and TX signing.

See Dapp template for live demo.

Requirements

Getting Started

The dapp is a client side only project and is built using the Create React App scripts.

Installation and running

Step 1. Install modules

From a terminal, navigate to the project folder and run:

yarn install

Step 2. Update environment

Go to App.tsx and edit the environment variable according to the environment you want the app to run on. Valid values are testnet, devnet or mainnet

If you need to edit the network configuration, you can pass in a customNetworkConfig object. More info about this can be found in sdk-dapp documentation

Step 3. Running in development mode

In the project folder run:

yarn start

This will start the React app in development mode, using the configs found in the config.tsx file. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.\ You will also see any lint errors in the console.

Step 4. Build for testing and production use

A build of the app is necessary to deploy for testing purposes or for production use. To build the project run:

yarn build

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

One can contribute by creating pull requests, or by opening issues for discovered bugs or desired features.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Known Issues

If you see some build error in docket or other CICD services related to vite and @rollup/rollup-linux-x64-gnu... you will need to git rm -r --cached ./package-lock.json locally and make sure you dont commit package-lock.json