Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/curvefi/curve-frontend
Curve-frontend is a user-interface DApp designed to connect to Curve's deployment of smart contracts.
https://github.com/curvefi/curve-frontend
Last synced: about 1 month ago
JSON representation
Curve-frontend is a user-interface DApp designed to connect to Curve's deployment of smart contracts.
- Host: GitHub
- URL: https://github.com/curvefi/curve-frontend
- Owner: curvefi
- License: mit
- Created: 2024-01-17T14:00:13.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-29T09:43:57.000Z (about 2 months ago)
- Last Synced: 2024-10-29T11:48:27.448Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://curve.fi/
- Size: 17.1 MB
- Stars: 20
- Watchers: 3
- Forks: 25
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://crvusd-curve.fi) and [Curve](https://curve.fi) dapps, and utilizes [curve-js](https://github.com/curvefi/curve-js) and [curve-stablecoin-api](https://github.com/curvefi/curve-stablecoin-js) to communicate with the blockchain.
## Prerequisites
Before you begin, ensure you have met the following requirements:
- [nodejs](https://nodejs.org/) version 20
- [yarn](https://yarnpkg.com/) version 1.22
## Installation
To install curve-frontend, follow these steps:
```bash
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:
```bash
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:
```bash
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](https://react.dev/) application.
- `/apps/loan`: crvUSD [React](https://react.dev/) application.
- `/apps/lend`: Lend [React](https://react.dev/) application.
- `/tests`: DApp tests
- `/packages/ui`: Shared CSS styled components using [styled-components](https://styled-components.com/).
- `/packages/onboard-helpers`: Shared wallet connection using [Blocknative's Onboard](https://onboard.blocknative.com/).
## Development Guide
For detailed information on development practices and usage of new libraries, please refer to our [Development Guide](./DEVELOPMENT_GUIDE.md).
## Testing
For testing the DApp application, follow these steps:
1. Navigate to the `tests` directory:
```bash
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](https://discord.gg/sGDwYnb6W9)
You may also submit an issue on our [GitHub Issue Tracker](https://github.com/curvefi/curve-frontend/issues).
## Contributing
To contribute to curve-frontend, follow these steps:
1. Fork this repository.
2. Create a branch: `git checkout -b `.
3. Make your changes and commit them: `git commit -m ''`
4. Push to the original branch: `git push origin /`
5. Create the pull request.
Alternatively see the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
## License
This project is licensed under the [MIT](LICENSE) license.