Skip to content

Latest commit

 

History

History
68 lines (44 loc) · 2.04 KB

README.md

File metadata and controls

68 lines (44 loc) · 2.04 KB
Raw

@multiversx/template-dapp

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

  • Node.js version 16.20.0+
  • Npm version 8.19.4+

Getting Started

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

Instalation and running

Step 1. Install modules

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

yarn install

Step 2. Running in development mode

In the project folder run:

yarn start:devnet
yarn start:testnet
yarn start:mainnet

This will start the React app in development mode, using the configs found in the vite.config.ts 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 3. 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:devnet
yarn build:testnet
yarn build:mainnet

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