Skip to content

Making it easier to evaluate public good projects across the regen ecosystem with quality endorsements.

License

Notifications You must be signed in to change notification settings

greenpill-dev-guild/impact-reef

Repository files navigation

Impact Reef

Overview

Impact Reef is a Web3-based project designed to improve the impact evaluation framework within the public goods ecosystem. The platform focuses on capturing qualitative input via endorsements and attestations using EAS (Ethereum Attestation Service) for public good projects. This approach provides evaluators with strong qualitative input, enhancing the robustness of impact assessments. This project is part of a broader mission by the Greenpill Dev Guild to elevate the visibility and effectiveness of impact metrics and their corresponding evaluations.

Getting Started

This repository is structured as a monorepo using pnpm. All code is located under the packages directory, which includes subdirectories for client and eas (containing scripts for deploying schemas and attestations to EAS). These can be run simultaneously in a local environment to facilitate end-to-end development and testing.

Prerequisites

Ensure you have the following dependencies installed:

  • Node.js version 18+ for running scripts and PNPM.
  • PNPM version 6+ for package management.

Installation

  1. Clone the repository:
    git clone https://github.com/greenpill-dev-guild/impact-reef.git
  2. Navigate to the project directory:
    cd impact-reef
  3. Install dependencies using pnpm:
    pnpm install
  4. Start the development environment:
    pnpm dev

Tests

Tests can be run at both the package level and root level for the client using pnpm run test.

Testing Structure

  • Clients: Tests are written using Vitest and Testing Library.

Architecture

The repository is organized into packages, each containing code for different aspects of the application, from clients to EAS scripts. The client package focuses on the user-facing interface, while the eas package handles Ethereum attestation schemas and related scripts.

Technologies Used