curve-frontend

Curve-frontend is a NextJs user-interface application designed to connect to Curve's deployment of smart contracts. This UI application is designed for both the crvUSD and Curve dapps, and utilizes curve-js and curve-stablecoin-api to communicate with the blockchain.

Prerequisites

Before you begin, ensure you have met the following requirements:

• nodejs version 20
• yarn version 1.22

Installation

To install curve-frontend, follow these steps:

git clone https://github.com/curvefi/curve-frontend.git
cd curve-frontend
yarn install

Usage

1. Copy .env.sample from /apps/(loan|main|lend) and update environment variables:

cp apps/loan/.env.sample apps/loan/.env.development.local
cp apps/main/.env.sample apps/main/.env.development.local
cp apps/lend/.env.sample apps/lend/.env.development.local

2. Start development:

yarn dev

Access the application in a web browser:

• Main app: http://localhost:3000
• crvUSD app: http://localhost:3001
• Lend app: http://localhost:3003

Forked Mainnet

To develop against a forked mainnet, connect your wallet to the RPC URL: http://localhost:8545 or whichever port your forked mainnet is using.

Folder Structure

This repository is organized as follows:

• /apps/main: This application manages router swaps, pool-specific functions (deposit, withdraw, swap), and pool creation React application.
• /apps/loan: crvUSD React application.
• /apps/lend: Lend React application.
• /tests: DApp tests
• /packages/curve-ui-kit: Shared UI kit created using Material UI, mapped as @/shared/ui
• /packages/curve-lib: Shared logic for the DApps, mapped as @/shared/lib
• /packages/curve-common: List of features for the DApps, mapped as @/common

Development Guide

For detailed information on development practices and usage of new libraries, please refer to our Development Guide.

Testing

For testing the DApp application, follow these steps:

1. Navigate to the tests directory:

cd tests

2. Follow the instructions in the README file located in the tests directory.

Troubleshooting

If you have any questions, please contact the dev channel on the Curve Discord

You may also submit an issue on our GitHub Issue Tracker.

Contributing

To contribute to curve-frontend, follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin <project_name>/<location>
5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

License

This project is licensed under the MIT license.