Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yearn/yearn.fi
https://github.com/yearn/yearn.fi
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/yearn/yearn.fi
- Owner: yearn
- License: gpl-3.0
- Created: 2022-11-18T14:19:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T14:39:46.000Z (20 days ago)
- Last Synced: 2024-10-25T13:58:29.353Z (19 days ago)
- Language: TypeScript
- Homepage: https://yearn.fi
- Size: 14.4 MB
- Stars: 22
- Watchers: 4
- Forks: 49
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# yearn.fi
Why?
### Initial Setup
- Fork the [original repo](https://github.com/yearn/yearn.fi) into your GitHub account
- Clone the forked repo from your GitHub account to your local machine
```
git clone https://github.com//yearn.fi.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.fi
```
- Set upstream to original repo.
```
git remote add upstream https://github.com/yearn/yearn.fi.git
```
- Optional: Create `.env` file in root directory of repo then copy contents of `.env.example` to `.env` and replace values with your own keys. If you do not do this the default values from `next.config.js` will be used.
```
cp .env.example .env
```
### Install and run
1. Run `yarn`
2. Run `yarn run dev`
3. Open the browser and navigate to `http://localhost:3000`
### Run with Docker
This project can be run with Docker.
1. Build the image: `docker build -t [name-of-your-container] .`
2. Run the container: `docker run -p 3000:3000 [name-of-your-container]`
3. Open the browser and navigate to `http://localhost:3000`
### Making Changes
- Create a new local branch from upstream/main for each PR that you will submit
```
git fetch
git checkout -b upstream/main
```
- 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/main
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`