Skip to content

Open educational project, to rebuild OpenCollective as a DApp.

Notifications You must be signed in to change notification settings

fussek/build-collective

 
 

Repository files navigation

DAAR Project 3 - Build Collective

  • Authors: Duc Huy Do, Patryk Fussek
  • Fall semester 2021

Video demo (YouTube link)

https://youtu.be/BjrnNH0MUZc

Video demo

DAAR.Build.Collective.ETH.project.3.Fussek.Duc.mp4

Installation

# With HTTPS
git clone https://github.com/ghivert/build-collective.git
# Or with SSH
git clone git@github.com:ghivert/build-collective.git

You’ll need to install dependencies. You’ll need Ganache, Node.js and NPM or Yarn. You’ll need to install Metamask as well to communicate with your blockchain.

  • Ganache is a local blockchain development, to iterate quickly and avoiding wasting Ether during development.
  • Node.js is used to build the frontend and running truffle, which is a utility to deploy contracts.
  • NPM or Yarn is a package manager, to install dependencies for your frontend development. Yarn is recommended.
  • Metamask is a in-browser utility to interact with decentralized applications.

Some setup

Once everything is installed, launch Ganache. Create a new workspace, give it a name, and accept. You should have a local blockchain running in local. Now you can copy the mnemonic phrase Ganache generated, open Metamask, and when it asks to import a mnemonic, paste the mnemonic. Create the password of your choice and that’s fine. Now you can connect Metamask to the blockchain. To do this, add a network by clicking on main network and personalized RPC. Here, you should be able to add a network.

Ganache Config

Once you have done it, you’re connected to the Ganache blockchain!

Run the frontend

Install the dependencies.

# Yarn users
yarn
# NPM users
npm install

Compile the contracts.

# Yarn users
yarn contracts:migrate
# NPM users
npm run contracts:migrate

Create a symlink for your OS if this is not done for you.

# Windows
mklink /D src\build "..\build"

# Unix and macOS
ln -s ../build ./src/build

Run the frontend

# Yarn users
yarn serve
# NPM users
npm run serve

You’re good to go!

Subject

Implement an OpenCollective from scratch in Solidity.

Smart Contract

  • Open user account, with a name and a balance.
  • Open an entreprise account, with a name, an owner and some members, possibly with a balance.
  • Create projects on which we can give money for sponsoring. Each project has a balance, a name and a list of contributors. Each project belongs to a user or an entreprise. The money given to the project can be send to contributors, and contributors only.
  • On a project, you should be able to create bounties. Bounties are bugs with a reward: if you spot a bug and you want to have it fix quickly, open a bounty and put some eth on it. When the fix is pushed, the author will get the eth. He’s a bounty hunter.
  • Add the ability to put some link to commits from GitHub or GitLab in the projects, to keep a track of what has been done.

Front

  • Create a page to open a user account. Remember, each user is identified by its wallet address.
  • Create a page to open an entreprise account.
  • Create a page to create a project.
  • Create a page to get a full recap of everything that happened on a project as a timeline.

Implementation

  • Solidity: There are new structures and methods for Enterprises, Projects and Bounties
  • Frontend: The interface currently supports only Enterprises and Projects.

About

Open educational project, to rebuild OpenCollective as a DApp.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Vue 68.0%
  • Solidity 17.9%
  • TypeScript 8.6%
  • JavaScript 3.5%
  • HTML 2.0%