Code Monkey home page Code Monkey logo

dgrants's Introduction

dgrants

Directory Structure

.
├── app                     # Frontend Vue.js application
├── contracts               # Smart contracts
├── doc                     # Project documentation including the protocol definition
├── lerna.json              # Lerna config
├── package.json            # Root package configuration
├── tsconfig.json           # Typescript configuration
├── tsconfig.settings.json  # Typescript configuration
├── types                   # Shared types
├── vetur.config.js         # Vetur configuration
├── yarn.lock               # Yarn lock file
└── README.md

Contributing Guideline

Checkout the CONTRIBUTING.md if you'd like to help with building dGrants

Development

This project is a monorepo with two packages:

  • contracts/ contains the smart contracts
  • app/ is a frontend

Dependencies

To ensure that everyone is using the same version of nodejs on this project, volta is recommended!

Set your env files

Copy app/.env.template to app/.env and edit, providing your own env vars. You will have to supply a Blocknative API key and an Infura Project ID. Both services have free tiers which are sufficient for development.

cp app/.env.template app/.env

Copy contracts/.env.template to contracts/.env and edit, providing your own env vars

cp contracts/.env.template contracts/.env

You will have to supply an Infura Project ID. An account with their free tier is sufficient for development.

Develop

yarn
yarn dev

Lint

yarn lint

Test

yarn test

Build

yarn build

Note: Subdirectory Development

If you are working on one component or the other, you can use workspace aliases to run commands defined in the corresponding package.json independently.

For example, to run smart contract tests only:

yarn contracts test

or to start the frontend locally in development mode:

yarn app dev

Help Build Decentralized Gitcoin

As of August 2021, Gitcoin Holdings is Hiring Engineers -- Say hi in the #decentralize-gitcoin channel on the Gitcoin Discord to get involve

dgrants's People

Contributors

mds1 avatar gdixon avatar corydickson avatar thelostone-mc avatar wildmolasses avatar phutchins avatar apbendi avatar metafraction avatar jferas avatar owocki avatar frankchen07 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.