Giter VIP home page Giter VIP logo

funds's Introduction

DappFundsX Project Documentation

Charity Marketplace The DappFund.sol project is a Solidity-written Ethereum smart contract that serves as the backbone of a decentralized application (dApp) for charity purposes. It leverages the OpenZeppelin library to ensure secure and standardized development of the contract.

Charity Marketplace The contract is designed around two primary structures: CharityStruct and SupportStruct, representing a charity and a supporter, respectively.

Key features:

  • createCharity: Allows a user to create a new charity.
  • updateCharity: Allows the charity owner to update the details of an existing charity.
  • deleteCharity: Allows the charity owner or contract owner to delete a charity.
  • toggleBan: Allows the contract owner to ban or unban a charity.
  • donate: Allows a user to donate to a charity.
  • changeTax: Allows the contract owner to change the tax percentage.
  • getCharity: Returns a single charity by its ID.
  • getCharities: Returns all existing charities.
  • getMyCharities: Returns all charities created by the caller.
  • getSupports: Returns all supporters for a specific charity.

Running the Application

Supply the following keys in your .env variable:

NEXT_PUBLIC_RPC_URL=http://127.0.0.1:8545
NEXT_PUBLIC_ALCHEMY_ID=<YOUR_ALCHEMY_PROJECT_ID>
NEXT_PUBLIC_PROJECT_ID=<WALLET_CONNECT_PROJECT_ID>
NEXTAUTH_URL=http://localhost:3000
NEXTAUTH_SECRET=somereallysecretsecret

YOUR_ALCHEMY_PROJECT_ID: Get Key Here WALLET_CONNECT_PROJECT_ID: Get Key Here

Follow these steps to run the application:

  1. Install the package modules by running the command: yarn install
  2. Start the Hardhat server: yarn blockchain
  3. Run the contract deployment script: yarn deploy
  4. Run the contract seeding script: yarn seed
  5. Spin up the Next.js development server: yarn dev

Now, your application should be up and running.

๐Ÿ“š Key Technologies

  • ๐ŸŒ Next.js: A React framework for building server-side rendered and static websites.
  • ๐Ÿ“˜ TypeScript: A statically typed superset of JavaScript.
  • ๐Ÿ“ฆ Hardhat: A development environment for Ethereum smart contracts.
  • ๐ŸŒ EthersJs: A library for interacting with Ethereum and Ethereum-like blockchains.
  • ๐Ÿ“š Redux-Toolkit: A library for managing application state.
  • ๐ŸŽจ Tailwind CSS: A utility-first CSS framework.
  • ๐ŸŒˆ @rainbow-me/rainbowkit-siwe-next-auth: A library for authentication in Ethereum dApps.
  • ๐Ÿ“ React-Toastify: A library for adding toast notifications to your React application.
  • ๐Ÿ“œ Swiper: A modern mobile touch slider.
  • ๐Ÿ“š Wagmi: A library for building Ethereum dApps.

Useful links

funds's People

Contributors

janotchain 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.