docs: adds overview for react-dapp-v2-with-ethers

This commit is contained in:
Ben Kremer 2022-02-21 13:47:16 +01:00
parent 288f19a12a
commit c4b93e771a

View File

@ -1,6 +1,18 @@
# WalletConnect React App
# React dApp (with v2 EthereumProvider + Ethers.js)
## Getting Started
🔗 Live dapp demo - https://react-dapp-v2-with-ethers.vercel.app <br />
🔗 Live wallet demo - https://react-wallet-v2.vercel.app <br />
📚 WalletConnect v2 Docs - https://docs.walletconnect.com/2.0
## Overview
This is an example implementation of a React dApp (generated via `create-react-app`) using the v2 [`EthereumProvider`](https://docs.walletconnect.com/2.0/quick-start/dapps/ethereum-provider) together with [`Ethers.js`](https://docs.ethers.io/v5/) to:
- handle pairings
- manage sessions
- send JSON-RPC requests to a paired wallet
## Running locally
Install the app's dependencies:
@ -14,6 +26,12 @@ Set up your local environment variables by copying the example into your own `.e
cp .env.local.example .env.local
```
Your `.env.local` now contains the following environment variables:
- `REACT_APP_PROJECT_ID` (placeholder) - You can generate your own ProjectId at https://cloud.walletconnect.com
- `REACT_APP_INFURA_ID` (placeholder) - You can generate your own Infura ID via https://infura.io/
- `REACT_APP_RELAY_URL` (already set)
## Develop
```bash