Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanahem/romedao-calculator
(🏛️,🏛️) RomeDAO Rewards Calculator
https://github.com/hanahem/romedao-calculator
cryptocurrency defi finance
Last synced: 10 days ago
JSON representation
(🏛️,🏛️) RomeDAO Rewards Calculator
- Host: GitHub
- URL: https://github.com/hanahem/romedao-calculator
- Owner: hanahem
- License: gpl-3.0
- Created: 2021-11-27T11:39:33.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-03-03T23:34:38.000Z (almost 3 years ago)
- Last Synced: 2024-10-08T03:20:58.359Z (3 months ago)
- Topics: cryptocurrency, defi, finance
- Language: TypeScript
- Homepage: https://romedaocalculator-hanahem.vercel.app/
- Size: 165 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# (🏛️,🏛️) RomeDAO Rewards Calculator
A rewards calculator for [RomeDAO](https://romedao.finance).
*It goes without saying: thanks to [Lobis](https://github.com/LobisHQWorkspace) for the inspiration.*
*The calculator and app are not directly affiliated to RomeDAO. The calculator link is pinned in the Discord on #trading*
### How to deploy locally
Clone the repo and run:
```
yarn
yarn run dev
```
To start developing locally.
There are no env variables needed.
### How does it work
The `CalculatorContext` is where the data fetching happens. We use ethers to instantiate contracts, and call the various functions.
Once we read and compute all the needed data, we send them through a `useCalculator` hook in the `Calculator.tsx` component.
There the data is computed, formatted and displayed.
## Contribute
### How to contribute
There are some things that need to be fixed. And some refactoring is needed. You can either:
- Report a bug or an issue in [issues](https://github.com/hanahem/romedao-calculator/issues)
- Create an [issue](https://github.com/hanahem/romedao-calculator/issues) and announce that you are building the fix
- Directly create your pull request
To contribute, fork the repo on your profile, do your edits, and create a pull request here based on develop.
### Format
There's some format to follow when you create an issue, it so for better communication and experience.
**Issues template**
```
Title: Title of your issue
Type: Bug/Enhancement/Feature/Request/Other
Details: Details
I'm on it: Yes or No
```
**PRs template**
```
Title: Title of your issue
Type: Bug/Enhancement/Feature/Request/Other
Details: Details
Fixes: Link an issue if needed
```
## To Rome!
Contributions are open for everyone, don't hesitate to bring your knowledge, or to come here to enhance your skills.
It is also a good repo to start learning web3 and front-end development.
Don't forget a look at [ROMEDAO](https://romedao.finance).
And (🏛️,🏛️)!!
## Socials
You can contact me through [Twitter](https://twitter.com/0xethercake) if needed.