Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/multiversx/mx-template-dapp
https://github.com/multiversx/mx-template-dapp
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/multiversx/mx-template-dapp
- Owner: multiversx
- Created: 2021-05-12T14:05:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T12:58:30.000Z (6 months ago)
- Last Synced: 2024-04-01T15:08:43.213Z (6 months ago)
- Language: TypeScript
- Size: 16.3 MB
- Stars: 61
- Watchers: 20
- Forks: 63
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-multiversx-dev-resources - MultiversX dApp template - The official dApp template provided by the MultiversX team using React.js & Typescript. It's a basic implementation of [@multiversx/sdk-dapp](https://www.npmjs.com/package/@multiversx/sdk-dapp), providing the basics for MultiversX authentication and TX signing. (MultiversX official / Dev dApps)
README
# @multiversx/template-dapp
The **MultiversX dApp Template**, built using [React.js](https://reactjs.org/) and [Typescript](https://www.typescriptlang.org/).
It's a basic implementation of [@multiversx/sdk-dapp](https://www.npmjs.com/package/@multiversx/sdk-dapp), providing the basics for MultiversX authentication and TX signing.
See [Dapp template](https://template-dapp.multiversx.com/) 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](https://create-react-app.dev) scripts.
### Instalation and running
### Step 1. Install modules
From a terminal, navigate to the project folder and run:
```bash
yarn install
```
### Step 2. Running in development mode
In the project folder run:
```bash
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](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:
```bash
yarn build:devnet
yarn build:testnet
yarn build:mainnet
```
## Roadmap
See the [open issues](https://github.com/multiversx/mx-template-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