Green Goods

Measures, tracks, and rewards the impact on gardens with a simple progressive web app.
https://github.com/greenpill-dev-guild/green-goods

Category: Biosphere
Sub Category: Biodiversity Citizen Science

Keywords

attestations biodiversity biodiversity-monitoring community conservation environment ethereum foundry greenpill impact ipfs public-goods pwa regenerative smart-contracts solidity tailwindcss typescript vite web3

Keywords from Contributors

transforms archiving measur generic optimize observation compose conversion projection animals

Last synced: about 4 hours ago
JSON representation

Repository metadata

Bringing biodiversity data onchain to better measure, track and reward impact on gardens with a simple PWA.

• Host: GitHub
• URL: https://github.com/greenpill-dev-guild/green-goods
• Owner: greenpill-dev-guild
• License: mit
• Fork: true (greenpill-dev-guild/camp-green)
• Created: 2024-04-29T00:11:50.000Z (12 months ago)
• Default Branch: develop
• Last Pushed: 2025-04-12T22:13:07.000Z (14 days ago)
• Last Synced: 2025-04-20T00:11:32.903Z (7 days ago)
• Topics: attestations, biodiversity, biodiversity-monitoring, community, conservation, environment, ethereum, foundry, greenpill, impact, ipfs, public-goods, pwa, regenerative, smart-contracts, solidity, tailwindcss, typescript, vite, web3
• Language: TypeScript
• Homepage: https://greengoods.app
• Size: 14.2 MB
• Stars: 13
• Watchers: 0
• Forks: 1
• Open Issues: 40
• Releases: 0

https://github.com/greenpill-dev-guild/green-goods/blob/develop/

          ## Overview

Green Goods is an innovative Progressive Web App (PWA) designed to revolutionize biodiversity conservation. By providing tools for Garden Operators and Gardeners, the app streamlines the documentation and approval of conservation work. Key features include:

- **Work Submission:** Gardeners can capture and upload images of their conservation efforts.
- **Plant AI Detection (In Development):** Automatically verifies that uploaded images contain valid plant data using external APIs (with plans to explore local model deployment).
- **Blockchain Integration:** Securely records work attestations on-chain using Ethereum Attestation Service (EAS) and related blockchain components.
- **Impact Reporting:** Aggregates data for standardized impact metrics like invasive species removal, biomass generation, and carbon sequestration.

## Getting Started

### Prerequisites

- **Node.js & npm:** Ensure you have Node.js (version 20 or higher) and npm installed.
- **Git:** Version control is managed with Git.
- **Foundry:** For smart contract development and testing.
- **Docker (optional):** For local development and containerized deployments.

### Installation

1. **Clone the Repository:**
   ```bash
   git clone https://github.com/greenpill-dev-guild/green-goods.git
   cd green-goods
   ```
2. **Install Dependencies:**

   ```bash
   pnpm install
   ```

3. **Configure Environment Variables:** Create a .env file in each package as needed by copying the example .env file and set the necessary environment variables (e.g., API keys for plant detection, blockchain endpoints, etc.):

_Reachout to the Green Goods team on the [Greenpill Dev Guild Discord](https://discord.gg/XgU4emTW7M) to get environment variables._

4. **Build and Run the App:**
   ```bash
   pnpm run dev
   ```

The top `pnpm run dev` will run the Vite development server for the **Client** and for **Contracts** it will compile and build the smart contracts.

### Client

The Green Goods client is built using React and Vite. To run the development server, navigate to the client directory and run the following command:

1. **Run the Development Server:**
   ```bash
   pnpm run dev
   ```

The app should now be running at http://localhost:3001.

2. **Build for Production:**
   ```bash
   pnpm run build
   ```

The app will be built in the `dist` directory.

### Contracts

The Green Goods smart contracts are built using Foundry and deployed to a local blockchain (e.g., Anvil) or a public blockchain (e.g., Arbitrum).

1. **Compile Contracts:**

   ```bash
   pnpm run compile
   ```

2. **Build Contracts:**

   ```bash
   pnpm run build
   ```

3. **Deploy Contracts:** There are multiple deploy:\* scripts for different contracts and functionality. Each one simulate the transaction and in order to run onchain will need a `--broadcast` flag.

   ```bash
   pnpm run deploy:counter --broadcast
   ```

## Architecture

Green Goods is built using a modern, modular architecture to ensure scalability and maintainability. The main components include:

### Frontend

Built with React (using Vitejs) and styled with TailwindCSS.

Implements a mobile-first PWA design for seamless user experience on both mobile and desktop.

Integrates real-time image validation and plant detection UI flows.
API Integration Layer:

Handles calls to external plant detection services (e.g., Plant.id, PlantNet, Kindwise) for image analysis.
Processes API responses and integrates detection data into work metadata.

### Backend & Blockchain Integration

Manages user submissions, work approvals, and conservation impact reports.

Deploys a Garden NFT contract that deploys tokenbound smart account owned by the NFT holder.

Deploys an Action Registry smart contract that enables creating new actions for work submission, work approval, and impact reporting.

Integrates with Ethereum Attestation Service (EAS) for blockchain-based attestations.

Uses a Ethereum Attestation and Envio Graphql Indexer to read blockchain events asynchronously.

_Refer to Green Goods technical specs for [work](https://app.charmverse.io/greenpill-dev-guild/green-goods-work-spec-2986399741355552) and [plant detection](https://app.charmverse.io/greenpill-dev-guild/green-goods-ai-plant-detection-spec-2926920793393595) for more details._

## Contributing

We welcome contributions from the community! To contribute to Green Goods, please follow these steps:

1. **Fork the Repository:** Click the "Fork" button on the repository page to create your own copy.

2. **Create a Branch:** Create a new branch for your feature or bug fix:

```bash
git checkout -b feature/your-feature-name
```

3. **Make Your Changes:** Develop and test your changes locally. Make sure to update documentation and tests as needed.

4. **Submit a Pull Request:** Once your changes are ready, submit a pull request (PR) detailing what your contribution does and linking to any relevant issues.

5. **Review Process:** Our team will review your PR, provide feedback, and work with you to merge your contribution.

        

---

Owner metadata

• Name: Greenpill Dev Guild
• Login: greenpill-dev-guild
• Email:
• Kind: organization
• Description: We're a collective of regen developers building tools for Greenpill chapters and regen communities.
• Website:
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/148837355?v=4
• Repositories: 2
• Last ynced at: 2024-03-15T01:28:40.225Z
• Profile URL: https://github.com/greenpill-dev-guild

---

GitHub Events

Total

• Create event: 7
• Commit comment event: 10
• Issues event: 19
• Watch event: 5
• Delete event: 1
• Issue comment event: 10
• Push event: 57
• Pull request review event: 15
• Pull request event: 15
• Fork event: 1

Last Year

• Create event: 7
• Commit comment event: 10
• Issues event: 19
• Watch event: 5
• Delete event: 1
• Issue comment event: 10
• Push event: 57
• Pull request review event: 15
• Pull request event: 15
• Fork event: 1

---

Committers metadata

Last synced: 1 day ago

Name	Email	Commits
Afo	o****1@g****m	110
0xWildhare	s****9@g****m	31
mrcn	m****a@g****m	1
dependabot[bot]	4****]	1
Alexander Mangel	c****r@g****m	1

Committer domains:

---

Issue and Pull Request metadata

Last synced: 1 day ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/greenpill-dev-guild/green-goods

---

---

Score: 5.579729825986222