curve-frontend

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

Prerequisites

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

• NodeJS Active LTS version
• yarn version 4.x

Installation

To install curve-frontend, follow these steps:

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

Usage

Start development:

yarn dev

Access the application in a web browser:

• http://localhost:3000

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.
• /packages/curve-ui-kit: Shared UI kit created using Material UI, mapped as @ui-kit
• /packages/prices-api: Package for consuming the Prices API, mapped as @curvefi/prices-api. Soon to be to separated its own NPM package.
• /tests: Cypress tests

Development Guide

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

Testing

Check the README in the tests directory for instructions on how to run end-to-end tests using Cypress.

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.