Prerequisites

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

Part 1: Setting up your local environment

Step 1: Clone the repo

Clone the repository and navigate to its directory:

git clone https://github.com/dydxfoundation/bridge.git
cd bridge

Step 2: Install pnpm and dependencies

Install pnpm and the project dependencies:

npm i -g pnpm
pnpm i

Part 2: Running the project locally

Run the following command in the project directory to start the development server:

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)
• VITE_WALLETCONNECT2_PROJECT_ID: Project ID for Wallet Connect. Create a project via their dashboard, 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.

The primary license for this project is the GNU Affero General Public License v3.0 (AGPL-3.0), see LICENSE.