Skip to content

Latest commit

 

History

History
119 lines (91 loc) · 4.72 KB

README.md

File metadata and controls

119 lines (91 loc) · 4.72 KB
Raw

📜 Campaign Contract

A new way of funding a project or venture by raising small amounts of money from a large number of people via ethereum blockchain technology without any middleman to function or to manage a user’s information.

Screen-shot

Home Page

Home Page

Campaigns Dashboard

Campaigns Dashboard

Campaigns Request

Campaigns Request

CampaignFactory

Variables

variable data types desc
deployedCampaigns address[] addresses of all the deployed contract


Function

name desc
createCampaign create a new campaign contract
getDeployedCampaigns return addresses of all the deployed contract

Campaign

Variables

variable data types desc
manager address address of the person who is managing this compaign
minimumContribution unint Minimum donation required to be considered a contributor or 'approver'
approvers address[] List of addresses for every person who has donated money
requests Request[] List of requests that the manager has created.


Functions

name desc
Campaign constructor function that sets the minimumContribution and the owner
contribute called when someone wants to donate money to the compaign and become an 'approver'
createRequest called by the manager to create a new 'spending request'
approveRequest called by each contributor to approve a spending request
finalizeRequest After a request has gotten enough approvals, the manager can call this to get money sent to the vendor
getSummary() function to retrieving Campaign balance, minimumContribution , no of requests , no of Contributors and manager address
getRequestsCount() function returning no of requests


Request Struc

Name Type Purpose
description string Describes why the request is being created
value uint Amount of money that the manager wants to send to the vendor
recipient address Address that the money will be sent to
complete bool True if the request has already been processed (money sent)

Prerequisite

  1. Install Metamask as Google Chrome Extension and Create an account.

  2. Request Ether by sharing your ethereum address in social media
    (https://faucet.rinkeby.io/)

  3. Get 0.01 ether free by giving the ethereum address
    (http://rinkeby-faucet.com/)

  4. Create an account in https://infura.io

  5. Create .env file in Ethereum directory and add these line to it.

    mnemonic = 'Your mnemonic code'
    link = 'Your infura end point link '

  6. Deploy Contract by going into Ethereum Directory and run.

    node deploy.js

    Copy the contract deploy address and replace it in factory.js file.

  7. Replace your "infura end point link" in web3.js file

Dependencies Used

Name Version Description
solc 0.4.26 Programming language to write smart contracts
ganache-cli 6.5.1 Local Ethereum Test Network
mocha 6.2.0 JavaScript test framework
truffle-hdwallet-provider 1.0.16 The Truffle HDWallet provider is a convenient and easy to configure network connection to ethereum through infura.io
web3 1.0.0-beta.55 Ethereum JavaScript API which connects to the Generic JSON RPC spec.
dotenv 8.0.0 Loads environment variables from a .env file into process.env
fs-extra 8.1.0 file system methods that aren't included in the native fs
next 9.0.3 JavaScript framework to build server-side rendering and static web application using React
react 16.9.0 JavaScript library for creating user interfaces
react-dom 16.9.0 DOM specific methods that can be used on React application
semantic-ui-react 0.87.3 react component kit provides pre define react component
semantic-ui-css 2.4.1 react component kit provides theme to react component as CSS
next-routes 1.4.2 Dynamic Routes for Next.js

Steps

  • To install dependencies

npm install

  • To Compile the Contract

node compile.js

  • To test the Contract

npm run test

  • To deploy the Contract

node deploy.js

  • To run the application

npm run dev

UI Routing

Path Description
/ List of Campaigns
/campaigns/new Form to make a campaign
/campaigns/0x8147 Campaign details for campaign at address 0x8147
/campaigns/0x8147/requests Requests for campaign at address 0x8147
/campaigns/0x8147/requests/new Form to create a request for campaign at address 0x8147