Skip to content
Grow Open Source
Branch: master
Clone or download
Latest commit fdf9c6b Mar 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Adjust circleci and add gh pages deployment script Dec 17, 2018
.github Update with data requirements Feb 14, 2019
app CSS changes Mar 23, 2019
bin Adjust circleci and add gh pages deployment script Dec 17, 2018
charts Update secondary ingress Oct 18, 2018
docs Merge branch 'master' into infura-changes Mar 21, 2019
js-sdk Kudos v1 (#2492) Oct 27, 2018
ops Migrate to multistage build and alpine 3.8 image base Nov 30, 2018
requirements cleanup logging setup Mar 21, 2019
scripts log running_procs Mar 18, 2019
.dockerignore Draft create Oct 11, 2018
.editorconfig Initial commit for EthOS redemption May 4, 2018
.eslintignore make fix passing Feb 8, 2019
.eslintrc remove babel-eslint Feb 7, 2019
.gitignore gitignore sql files Mar 17, 2019
.helmignore Draft create Oct 11, 2018
.pre-commit-config.yaml restore pre-commit config Dec 24, 2018
.stickler.yml Update and include more apps to yapf Jul 9, 2018
.stylelintignore Kudos v1 (#2492) Oct 27, 2018
.stylelintrc birth: landing page (#1377) Jun 7, 2018
.travis.yml Migrate image converter to pyvips (#2346) Oct 4, 2018
CHANGELOG.md Enhancing user's profile Nov 13, 2018
Dockerfile svg to png Jan 25, 2019
Jenkinsfile Modify preview env match Oct 11, 2018
LICENSE updated date to 2017 -> 2019 Feb 12, 2019
Makefile Add makefile command to update stable from master Dec 26, 2018
OWNERS Update charts Oct 11, 2018
OWNERS_ALIASES Update charts Oct 11, 2018
detect Update charts Oct 11, 2018
docker-compose.yml Migrate to multistage build and alpine 3.8 image base Nov 30, 2018
package-lock.json fix node security vulnerabilities Mar 21, 2019
package.json fix node security vulnerabilities Mar 21, 2019
pydocmd.yml avatars history Jan 25, 2019
setup.cfg Upgrade django to 2.1, modify field defaults, and address deprecations ( Aug 9, 2018
skaffold.yaml Update charts Oct 11, 2018
web-datamodel-06JAN19.png Implement redeem page, more bufficorn goodness. Jan 6, 2019
webpack.config.js Revert "remove npm/yarn/webpack and see what breaks" Feb 6, 2019
yarn.lock Revert "remove npm/yarn/webpack and see what breaks" Feb 6, 2019

README.md

Gitcoin

Gitcoin Grows Open Source. Learn more at https://gitcoin.co

web repo

Build Status codecov Waffle.io - Columns and their card count

This is the website that is live at gitcoin.co master branch - staging stable branch - live on gitcoin.co

Documentation

https://docs.gitcoin.co

How to interact with this repo

Table of Contents

On Github

Star and watch this github repository to stay up to date, we're pushing new code several times per week!

Check out the CHANGELOG for details about recent changes to this repository.

Also,

On Gitcoin

Check out the available open issues on Gitcoin.

What is Gitcoin?

Functionally, the app has several key features:

  • Smart Contracts -- Where funded issues are stored and indexed.
  • Brochureware -- Describes the project.
  • Funded Issue Explorer -- A searchable index of all of the work available in the system.
  • Funded Issue Submission / Acceptance flow -- Interface between the application and web3.
  • API - the HTTPS API
  • Bot - the GitcoinBot

More about how/why to interact with web3 here.

Technically, the system is architected:

  • Web3 The main source of truth for the system is the Ethereum blockchain. Check out the smart contracts.
  • Web2 This part of the app is built with Python, Django, Postgres, and a handful of other tools that are common in the web2 ecosystem.
  • Web 3 Bridge This is the bridge between web3 and the rest of the application. Mostly built in javascript(web3js) and python(web3py).
  • Brochureware Just a nice little landing page telling folks what the Gitcoin project is.

Developing

HTTPS API

For more information on the HTTPS API, please view the api README

Running locally

With Docker (Recommended)

For more information on running the app locally, please view the documentation for running gitcoinco/web with Docker

Without Docker

For more information on running the app locally, please view the documentation for running gitcoinco/web without Docker

Overriding Application Defaults

For more information on overriding the local dev environment configuration defaults, please view the environment variables documentation

Trying out Gitcoin

Posting your first issue

If you

  • have some work on your Github Issues board that you don't have time (or skills) to do.
  • are dependant upon an upstream repo for something, and you'd like to incentivize them to work onit.

try posting a funded issue at https://gitcoin.co/new.

Integrating Gitcoin

Basics

Advanced

Background

Testimonials & Case Studies

Integrating the 'available work widget' into your repository

This widget will help you advertise that you support Gitcoin bounties, so that your community knows the best place to contribute.

Check out the widget documentation to learn how

Adding GitcoinBot to your repo

Gitcoinbot will allow you to add issues straight from github.

Check out the gitcoinbot readme to learn how

Adding your token to Gitcoin

Have an ERC20 compatible token that you'd like to use on the platform? Great! Submit this form to submit it to the system

High Level flows...

... of a Bounty

This is the high level flow of a bounty on Gitcoin:

Chain of Custody

  1. Bounty Funder's Wallet
  2. StandardBounties Smart Contract deployed at 0x2af47a65da8cd66729b4209c22017d6a5c2d2400
  3. (Submission Made)
  4. (Submission Accepted)
  5. Recipient's Wallet

Anywhere between 2 and 4 above, Funder may withdraw their funds via 'Cancel Bounty' function for any reason.

... of a Tip

ToDo

... of a Kudos

ToDo

Notes

  • Crowdfunded bounties + bulk payouts are secured by Tips (at least until Standard Bounties 2.0 is released).
  • Kudos are also secured by Tips

This is the high level flow of a bounty on Gitcoin:

Licenses

You can’t perform that action at this time.