diff --git a/.env b/.env.example similarity index 100% rename from .env rename to .env.example diff --git a/.gitignore b/.gitignore index 4d29575..f21726c 100644 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,7 @@ .env.development.local .env.test.local .env.production.local +.env npm-debug.log* yarn-debug.log* diff --git a/README.md b/README.md index 2aad7b2..0b8a7a1 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ # urbit-onboarding-app React app for onboarding to Urbit chain with Ethereum/Cosmos key attestation + +## Setup for urbit-onboarding-app + +1. Clone the repository + + ``` + git clone git@github.com:deep-stack/urbit-onboarding-app.git + ``` + +2. Enter the project directory + + ``` + cd urbit-onboarding-app + ``` + +3. Install dependencies + + ``` + yarn + ``` + +4. Setup .env + - Copy and update `.env` + + ``` + cp .env.example .env + ``` + + - In the `.env` file, add the WalletConnect project ID used in your [laconic-wallet](https://git.vdb.to/cerc-io/laconic-wallet) setup. + ``` + WALLET_CONNECT_PROJECT_ID=39bc93c... + ``` + +5. Start the application + + ``` + yarn start + ``` + \ No newline at end of file