Git Product home page Git Product logo

stakehub's Introduction

StakeHub

A decentralized application that enables users to stake ERC20 tokens and earn rewards in return.

Key Tokens

  • Stake Token : GOLD, ERC20 token used for staking within the DApp.
  • Reward Token : FIAT, Another ERC20 token generated as reward for staking.

Demo Image

Demo-Image

Functionality

  1. Stake Tokens:
  • Users approve a certain amount of stake tokens to be staked within the DApp by interacting with the staking smart contract.
  1. Generate Reward:
  • Once the stake tokens are staked, the smart contract generates reward tokens per second based on the staked amount.
  1. Accumulate Rewards:
  • Users accumulate reward tokens over time as they keep their stake tokens staked within the DApp.
  1. Claim Rewards:
  • Users can claim their accumulated rewards by interacting with the smart contract using the getReward() function.
  1. Unstake Tokens:
  • After a staking period or at any point, users can unstake their tokens using the appropriate function in the DApp to retrieve their staked tokens along with the accumulated rewards.

Contributions to this repo are WELCOME โšก๐Ÿ‘‹

  • ๐ŸŽจ Any improvements to the design and UI are welcome.
  • ๐Ÿ”จ try to break the website by testing it to find any bugs. If you find any, check if there is an issue already open for it, if there is none, then report it.

Tools, Languages and Frameworks used

  • React JS
  • Ether JS
  • Solidity
  • Hardhat

Steps to be followed in order to make valid contributions to this repo ๐Ÿ€

1. Fork the StakeHub repo by clicking on the fork button on the top of the page. This will create a copy of this repository in your account.

2. Clone the forked repository

    git clone "https://github.com/<your-github-username>/stakehub"
  • Download and install Node JS v16.16.0
  • Download and install Git.
  • Go to the terminal of your code editor and run "npm install" to download packages.
  • Run "npm run dev" to start a local server.

3. Make necessary changes and commit those changes.
Remember never push anything to the Main branch.

Always change your branch to "develop" using:

git checkout develop

Again check your current branch using:

git branch

It should point *develop

Now add your changes using:

git add files-you-edited

If there are multiple files you can use:

git add .

Now create a commit message using:

git commit -m "<commit-message-goes-here>"

4. Push changes to GitHub

git push origin develop

5. Create a Pull Request ๐Ÿ‘‹

Now you go to your repository on GitHub, youโ€™ll see a Compare & pull request button. Click on that button and now write a summary of what changes you have done.( Attach images if required). I will review your code and merge it if it passes all the tests.โค๏ธ

stakehub's People

Contributors

mrinnnmoy avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.