https://github.com/multiversx/mx-delegation-dapp

https://github.com/multiversx/mx-delegation-dapp

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/multiversx/mx-delegation-dapp
• Owner: multiversx
• Created: 2022-01-21T12:19:03.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-09-18T08:45:25.000Z (over 2 years ago)
• Last Synced: 2024-04-01T15:08:38.253Z (about 2 years ago)
• Language: TypeScript
• Size: 3.52 MB
• Stars: 6
• Watchers: 21
• Forks: 49
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          


  






[![](https://img.shields.io/badge/made%20by-MultiversX-blue.svg)](http://multiversx.com/)






 
Dapp boilerplate for Delegation 


  


The react implementation for Dashboard Delegation

    


    


    


    ·

    Report Bug

    ·

    Request Feature

  


  Table of Contents

  


    


Built With    

    


      Getting Started

      


        
Prerequisites

        
Installation

      

    

    
Usage

    
Roadmap

    
Contributing

  


### Built With

- [React](https://reactjs.org/)

- [Typescript](https://www.typescriptlang.org/)

- [Bootstrap](https://getbootstrap.com)

## Getting Started

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

Follow the next step to start using this dapp or follow the next tutorial on [Youtube](https://www.youtube.com/watch?v=BkjUmBsmQYM)

### Prerequisites

For _development_ you will need to have the following:

- node version 16.20.2

- npm

### Instalation and running

### Step 1. Install modules

From a terminal, navigate to the project folder and run `yarn install`

### Step 2. Update Configs

In the application's src folder there are 3 config files (config.devnet.ts, config.testnet.ts, config.mainnet.ts).

Based on the environment used the configs will need to be updated:

- delegationContract : should contain the address of the Delegation Smart Contract received after the creation of Delegation Smart Contract

- also check the walletAddress, apiAddress and explorerAddress

### Step 3. Create .env file

- copy `.env.example` to `.env`

- leave as it is to deploy on a root domain e.g. `staking.yourcompany.com` or add path e.g. `PUBLIC_URL=/staking/` if you wish to deploy the app in a subfolder.

### Step 4. Build for testing and production use

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

The dapp is configured with build scripts targeting either the public devnet, the public testnet or the public mainnet.

For testing on the devnet run => `yarn run build-devnet`

For testing on the testnet run => `yarn run build-testnet`

For production use on the mainnet run => `yarn run build-mainnet`

### Step 5. Run the dashboard

To run the project locally run `yarn start` from the project folder. This will start the React app in development mode, using the configs found in the config.ts file.

## Roadmap

See the [open issues](https://github.com/multiversx/mx-delegation-dapp/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