Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
VegeBun-csj committed Sep 21, 2024
1 parent 6fd87b8 commit 9f4e42a
Showing 1 changed file with 3 additions and 34 deletions.
37 changes: 3 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
## Prerequisites

- Node.js version 18 and `pnpm` installed on your system
- Alchemy account
- Wallet Connect account

## Part 1: Setting up your local environment
## Setting up your local environment

### Step 1: Clone the repo

Clone the repository and navigate to its directory:

```bash
git clone https://github.com/dydxfoundation/bridge.git
cd bridge
git clone https://github.com/DoraFactory/migration-user-interface.git
cd migration-user-interface
```

### Step 2: Install pnpm and dependencies
Expand All @@ -34,34 +33,4 @@ pnpm dev

The development server will be running at `http://localhost:5173` (or the port number displayed in the terminal). Visit this URL to interact with the web app and see your changes in real-time.

## Part 3: Deploying with Vercel

### Step 1: Connect your repository to Vercel

Select "Import Git Repository" from your dashboard, and provide the URL of this repository or your forked repository.

### Step 2: Configure your project

For the "Build & Development Settings", we recommend the following:

- Framework Preset: `Vite`
- Build Command (override): `pnpm run build`

For "Environment Variables", configure according to what needs to be overwritten in `.env`. In particular,

- `VITE_ALCHEMY_API_KEY`: Alchemy account API key ([docs](https://docs.alchemy.com/docs/alchemy-quickstart-guide#1key-create-an-alchemy-key))
- `VITE_WALLETCONNECT2_PROJECT_ID`: Project ID for Wallet Connect. Create a project via their [dashboard](https://cloud.walletconnect.com/app), and find the project ID.

To configure network (e.g. staging, testnet or mainnet),

- Update variables starting with `VITE_NETWORK_`, replace with the indexer and validator hosts of your choosing pointing to the desired network
- Update the rest of the variables (e.g. token / contract addresses / denom).

For more details, check out Vercel's [official documentation](https://vercel.com/docs).

The primary license for this project is the GNU Affero General Public License v3.0 (AGPL-3.0), see [LICENSE](https://github.com/dydxfoundation/bridge/blob/main/LICENSE).

## How to test Dora token Bridge
1. Obtain `SepoliaETH` for gas consumption. You can get 0.1SepoliaETH from here: https://faucets.chain.link/sepolia
2. Import token named `INF` in MetaMask for testing using the contract address: `0xe0A1A9e1a0704CE7B6c73988dbb4E2a54B846791`
> Bridge contract address: 0x9A3b7A8B2328375080E688820ddB29b420571eec

0 comments on commit 9f4e42a

Please sign in to comment.