The Giving - A Fully Decentralized Crowdfunding Platform

🎉 ETH Global 2022 Hackathon First Place Winner of Best Use of Sign in With Ethereum! 🚀

About The Project

The Giving is a fully decentralized charity organization like GoFundMe which is able to accept donations in crypto or fiat currencies.

Built With

• Next.js
• Tailwind CSS
• Solidity
• Polygon
• The Graph
• Sign-in with Ethereum

🏄‍♂️ Quick Start Options

Note: ./.devcontainer/devcontainer.json (or set your own if using Option 2 below) There are environmental variables that are set and may need to be updated to reflect accurate values.

{
    "containerEnv":{
        "STAGING_INFURA_URL":"<Infura URL >", # https://infura.io/ create project Eth->mumbai
        "STAGING_PRIVATE_KEY":"<Infura PK>", # currently set with a burner
        "ETHERSCAN_API_KEY":"<Etherscan API Key>" # https://etherscan.io/myapikey (set one up for yourself)
    }
}

Option 1 | .devcontainer super speed [Using Docker]

Using VScode

• Docker Desktop (windows)/Docker (linux)/Remote Docker connection with docker cli installed
• Ensure vscode extention: ms-vscode-remote.vscode-remote-extensionpack is installed
• Clone this repo and open in VScode
  • the IDE should detect the Dev Container configuration file.
  • Select [(Re)Open in Container]
  • the Docker container will build itself and auto attache itself to VSCode.
• If you want to start everything using launch.json with associated task.json
  • Switch to [Run and Debug] Side menu
  • A Green Right Arrow with Dropdown should be viewable. Select and Play
    • (1) [Start Project Chain] for yarn install && yarn chain in debug mode
    • (2) [Compile Contract(s)] for yarn hardhat:local-deploy in debug mode
      • note: this debug mode will auto close if the contracts are successful
    • (3) [Start Frontend] for yarn frontend in deubg mode
• Once all this is setup, you should be able to:
  • connect using localhost:8545 (Metamask) network
  • see "Hello World" at https://localhost:3000

Option 2 | The traditional set up your own env.

Prerequisites: Node (v16 LTS) plus Yarn and Git

To get this application up and and running on your local machine follow these simple steps.

Prerequisites

You need to have Node.js, NPM and hardhat installed on your computer, before running this project.

Installation

Clone the repo and cd to the project

git clone https://github.com/thegiving/thegivingdao thegiving
cd thegiving

install and start your 👷‍ Hardhat chain:

yarn install
yarn chain

in a second terminal window, 🛰 deploy your contract:

yarn hardhat:local-deploy

in a third terminal window, start your 📱 frontend:

yarn frontend

Deploy to Polygon Mumbai:

when you're ready to deploy to testnet:

yarn hardhat:testnet-deploy

automatically verify your contract:

yarn hardhat:testnet-verify

...and you're done! 🎉

📚 Documentation

For documentation visit: docs.thegiving.io