Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yearn/yearn-finance-v3
Yearn Finance Web App v3
https://github.com/yearn/yearn-finance-v3
Last synced: 8 days ago
JSON representation
Yearn Finance Web App v3
- Host: GitHub
- URL: https://github.com/yearn/yearn-finance-v3
- Owner: yearn
- Created: 2021-03-25T20:45:18.000Z (over 3 years ago)
- Default Branch: develop
- Last Pushed: 2023-04-20T17:57:16.000Z (over 1 year ago)
- Last Synced: 2023-11-07T16:32:35.232Z (about 1 year ago)
- Language: TypeScript
- Homepage: https://yearn.finance
- Size: 26.2 MB
- Stars: 124
- Watchers: 11
- Forks: 146
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# yearn.finance
> **Note**
> This version of the frontend has been deprecated in favor of https://github.com/yearn/yearn.fi but can still be accessed [here](https://v3.yearn.finance)
## Contributing
Code style follows prettier conventions (`yarn prettier`). Commit messages follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) spec.
### Initial Setup
- Fork the [original repo](https://github.com/yearn/yearn-finance-v3/) into your GitHub account
- Clone the forked repo from your GitHub account to your local machine
```
git clone https://github.com//yearn-finance-v3.git
```
- Set origin to your fork. This is where you push your changes to. This is done automatically by the step above.
```
git remote add origin https://github.com//yearn-finance-v3
```
- Set upstream to original repo.
```
git remote add upstream https://github.com/yearn/yearn-finance-v3.git
```
- Create `.env` file in root directory of repo then copy contents of `.env.example` to `.env`
```
cp .env.example .env
```
- `REACT_APP_INFURA_PROJECT_ID` should remain blank because we are currently using Alchemy as our provider
- `REACT_APP_ALCHEMY_API_KEY` alchemy api key should be provided by the contributor if he hits api limits
### Making Changes
- Create a new local branch from upstream/develop for each PR that you will submit
```
git fetch
git checkout -b upstream/develop
```
- Commit your changes as you work
```
git add .
git commit -S -m "message"
```
- [info about verified commits](https://docs.github.com/en/github/authenticating-to-github/managing-commit-signature-verification)
### Pushing Changes to your Repo
- Commits are squashed when PR is merged so rebasing is optional
- When ready to push
```
git fetch
git merge upstream/develop
git push origin
```
### Submitting Pull Request
- Go to your GitHub and navigate to your forked repo
- Click on `Pull requests` and then click on `New pull request`
- Click on `compare across forks`
- Click on `compare:` and select branch that you want to create a pull request for then click on `create pull request`
## Development
```
yarn dev
```
or for Windows:
```
yarn dev-win
```
- To enable Dev Mode set `REACT_APP_ALLOW_DEV_MODE=true` in your `.env`
- Wallet Address Override can be activated by navigating to Settings in the app and clicking `Enable Dev Mode`
## Production
```
yarn build
yarn start
```
## Translations
We use i18n react with locize cli to update/download translations.
Refer to main repo for documentation:
https://github.com/locize/locize-cli
Sync with: `yarn syncDevLocales` **must provide api key**
Check sync changes with: `yarn checkDevLocales`
Download prod locales with: `yarn downloadProdLocales`