Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/greenpill-dev-guild/impact-reef
Making it easier to evaluate public good projects with quality endorsements.
https://github.com/greenpill-dev-guild/impact-reef
attestations community eas endorsements grants graphql greenpill impact impact-evaluation ipfs optimism public-goods qualitative-data react smart-contracts social-impact solidity supabase typescript web3
Last synced: 14 days ago
JSON representation
Making it easier to evaluate public good projects with quality endorsements.
- Host: GitHub
- URL: https://github.com/greenpill-dev-guild/impact-reef
- Owner: greenpill-dev-guild
- License: mit
- Created: 2024-04-04T10:42:28.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-10-23T18:31:43.000Z (28 days ago)
- Last Synced: 2024-10-24T04:11:18.414Z (27 days ago)
- Topics: attestations, community, eas, endorsements, grants, graphql, greenpill, impact, impact-evaluation, ipfs, optimism, public-goods, qualitative-data, react, smart-contracts, social-impact, solidity, supabase, typescript, web3
- Language: TypeScript
- Homepage: https://impactreef.app
- Size: 3.69 MB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Impact Reef
## Overview
Impact Reef is a Web3-based project designed to improve the impact evaluation framework within the Optimism 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](https://nodejs.org/en/download/current) version 18+ for running scripts and PNPM.
- [PNPM](https://pnpm.io/installation) version 6+ for package management.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/greenpill-dev-guild/impact-reef.git
```
2. Navigate to the project directory:
```bash
cd impact-reef
```
3. Install dependencies using pnpm:
```bash
pnpm install
```
4. Start the development environment:
```bash
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
- **Language**:
- [Typescript](https://www.typescriptlang.org/download): Used across both client and EAS scripts.
- **Core Libraries**:
- [Next.js](https://nextjs.org): Framework used for building the client-side application.
- [EAS (Ethereum Attestation Service)](https://attest.org): Used for creating and managing attestations on-chain.