Add README steps (#11)

* Add README

* Add gitea link for laconic-wallet

* Add new line

* Add example env

---------

Co-authored-by: Shreerang Kale <shreerangkale@gmail.com>
This commit is contained in:
IshaVenikar 2024-04-29 09:34:25 +05:30 committed by GitHub
parent 1f11e283d7
commit f8abf9ea76
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 40 additions and 0 deletions

View File

1
.gitignore vendored
View File

@ -17,6 +17,7 @@
.env.development.local
.env.test.local
.env.production.local
.env
npm-debug.log*
yarn-debug.log*

View File

@ -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
```