README.md

Defi Stake

A Dapp that let's you stake WETH, FAU tokens and get DAPP tokes as rewards.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. License
4. Contact
5. Acknowledgments

About The Project

This is a fun weekend project to get myself onboared to build decentralized applications.

(back to top)

Built With

This project was build using the following tools

• VS code
• Python3
• Brownie
• Typescript
• React
• Material Design
• Yarn
• useDapp

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

You will need the following to be able to run this project locally

• Python3
• Brownie
• Infura project key - If you need to deploy to main/ test net
• Etherscan project key - Required if you want to verify the smart contract deployement
• Metamask wallet
• React

Installation

1. Clone the repo

   git clone https://github.com/adityaladwa/eth-defi.git

2. Create .env file in root of project with the following variables

    export PRIVATE_KEY=
    export WEB3_INFURA_PROJECT_ID=
    export ETHERSCAN_TOKEN=

3. Compile and deploy smart contract

   brownie compile
   brownie run scripts/deploy.py

4. Run the frontend app

   cd front_end 
   yarn start

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

• Solidity, Blockchain, and Smart Contract Course – Beginner to Expert Python Tutorial
• Brownie
• React
• useDapp

(back to top)