https://github.com/burgossrodrigo/vfat-tools

https://github.com/burgossrodrigo/vfat-tools

Last synced: 26 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/burgossrodrigo/vfat-tools
• Owner: burgossrodrigo
• License: other
• Created: 2021-08-23T14:27:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-24T14:15:57.000Z (over 3 years ago)
• Last Synced: 2023-03-07T02:49:56.522Z (almost 2 years ago)
• Language: JavaScript
• Size: 10.2 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## vfat.tools

_It ain't much, but it's honest work_

App : https://vfat.tools

Original work: https://yieldfarming.info

## How to run locally

Fork the repo and clone it to your PC, or just clone the original.

Run `npm install` (once) and `npm run dev`

This should bring up the interface at localhost:3000 after a minute or two.

## How to submit a new project, or any changes

- Fork the project

- Clone your forked copy onto your PC

- Create a new branch, make the required changes, *test it locally* using the above method

- Commit to your branch and push to your repo

- Go to your repo's github page and click Submit a pull request

This article is also a good explainer on the pull request system: https://opensource.com/article/19/7/create-pull-request-github

If you need help with the above process you can contact me on twitter, or telegram, vfat0 on both.

If you are unable to submit a new project this way, you can open a new Issue https://github.com/vfat-tools/vfat-tools/issues. Please include your project's URL and farming contracts (Masterchef, Synthetix Staking, Vaults), in the form of links to etherscan/bscscan/etc. Contracts need to be verified. After submitting an issue, please be patient for it to be processed by one of the contributors. Please note that projects with non-standard farming have to be submitted via pull request.

## Typical changes required

For most new pages you will need three things:

1) A new folder in src/views/pages and an index.ejs file in there for the view

2) A js file with the logic in src/static/js

3) Adding the project to the index for that chain, e.g. src/static/js/bsc.js * **

\* Please note project are added chronologically, newest at the bottom.

** Please do not add any projects to the front page index, if on ETH use all.js

## MCN Dual farming

MCN is a new type of decentralized fund, which offers dual token farming for onboarded projects. Please read the [listing guide](https://mcndvf.medium.com/mcn-farm-listing-guide-b4f8e3c3ec41) if you would like to submit your project for this.