From c4b93e771a9f1853d1d9ba6893cb7c981848f8ed Mon Sep 17 00:00:00 2001 From: Ben Kremer Date: Mon, 21 Feb 2022 13:47:16 +0100 Subject: [PATCH] docs: adds overview for `react-dapp-v2-with-ethers` --- dapps/react-dapp-v2-with-ethers/README.md | 22 ++++++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/dapps/react-dapp-v2-with-ethers/README.md b/dapps/react-dapp-v2-with-ethers/README.md index be97f5d..f0ac45e 100644 --- a/dapps/react-dapp-v2-with-ethers/README.md +++ b/dapps/react-dapp-v2-with-ethers/README.md @@ -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
+🔗 Live wallet demo - https://react-wallet-v2.vercel.app
+📚 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