ripples3 / grants-stack

Round Manager & Grant Explorer & Project Builder of the Grants Protocol

grants-round

This repository contains packages needed for a user to

• Create & Manage Rounds
• Explore available Rounds
• Vote for Projects within a Round

Project Maintained via : turborepo Package manager : pnpm

Directory Structure

.
├── .github                     # github specific configuration
├── packages
│   ├── round-manager           # react-frontend for round-manager
│   ├── grant-explorer          # react-frontend for grant-explorer
│   ├── builder                 # react-frontend for builder
│   ├── common                  # components and functionality that is shared between projects
│   ├── eslint-config-gitcoin   # common eslint config for all grants stack projects
├── package.json                # root package configuration
└── README.md

Git Hooks

You can optionally enable pre-commit git hooks that autoformat your changed code using prettier.

brew install lefthook
lefthook install

inspect the current hook configuration in lefthook.yml

contracts

The contracts needed for running a round can be found within the Allo contracts repository

graph

The subgraph which indexs data with regard the

• ProgramFactory
• ProgramImplementation
• RoundFactory
• RoundImplementation

More information can be found within the Allo graph repository

Packages

round-manager

This package serves the app which holds all the features w.r.t to

• creating a program
• maintaining a program
• creating a round
• maintaining a program

More information can be found within the round-manager package

Development

We welcome external contributions. Please make sure to familiarize yourself with the Contribution Guide.

To contribute to this project, fork the project and follow the instructions at DEV.md

grant-explorer

This package serves the app which holds all the features w.r.t to

• exploring a round
• voting for a project

More information can be found within the grant-explorer package

Development

We welcome external contributions. Please make sure to familiarize yourself with the Contribution Guide.

To contribute to this project, fork the project and follow the instructions at DEV.md

Hosting

All the frontend dApps are hosted via fleek.co.

Documented below are the environments along with the URL.

Note: Live Deployment should always happen by raising a PR from main to release

round-manager

Env	Git Branch	URL
STAGING	main	https://rmgitcoin.on.fleek.co/
LIVE	release	https://manager.gitcoin.co/