Giter Club home page Giter Club logo

thegiving / thegivingdao Goto Github PK

View Code? Open in Web Editor NEW
5.0 3.0 3.0 6.68 MB

A fully decentralized crowdfunding platform that accepts donations in crypto or fiat currencies. Built with Next.js and the Polygon blockchain.

Home Page: https://thegiving.vercel.app/

JavaScript 5.85% CSS 1.42% Shell 0.32% TypeScript 82.12% Solidity 8.28% Dockerfile 2.01%
apollo-client ethereum infura ipfs nextjs polygon rainbowkit thegraph signinwithethereum eth-global

thegivingdao's Introduction


Logo

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

Product Name Screen Shot

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

Built With

๐Ÿ„โ€โ™‚๏ธ 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:

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

thegivingdao's People

Contributors

fullofentropy avatar shireen-taha avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

thegivingdao's Issues

Create a generalized devcontainer for use in vscode

Create a .devcontainer to make it easy for others to contribute to

IDE: VScode

  • builds container to include required dependencies
  • adds vscode extentions for user convienence
  • add debug launch commands to easily get the chain, hardhat, and frontend execution with little overhead to developer.

Integrate proper open source statements into project.

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

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.