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 collaboration community environment ethereum filecoin foundry greenpill ipfs knowledge-garden local-first p2p pwa regen-coordination solidity storacha tailwindcss typescript vite

Keywords from Contributors

conservation biodiversity biodiversity-monitoring impact regenerative smart-contracts

Last synced: about 24 hours ago
JSON representation

Repository metadata

Bringing community and environmental actions onchain to better measure, track and reward impact on local communities 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 (about 2 years ago)
• Default Branch: develop
• Last Pushed: 2026-05-08T01:42:48.000Z (6 days ago)
• Last Synced: 2026-05-08T03:37:12.468Z (6 days ago)
• Topics: attestations, collaboration, community, environment, ethereum, filecoin, foundry, greenpill, ipfs, knowledge-garden, local-first, p2p, pwa, regen-coordination, solidity, storacha, tailwindcss, typescript, vite
• Language: TypeScript
• Homepage: https://greengoods.app
• Size: 156 MB
• Stars: 22
• Watchers: 1
• Forks: 5
• Open Issues: 3
• Releases: 0

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

          # Green Goods

[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://github.com/greenpill-dev-guild/green-goods/releases)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)

**Bringing community and environmental actions onchain to better measure, track and reward impact.**

Green Goods is an offline-first platform for documenting ecological and social work and proving impact on-chain. Operators approve gardener submissions, and the protocol anchors results in Ethereum attestation infrastructure.

## Getting Started

### Prerequisites

Install **Node.js 22+** and **Git**. Install **Docker Desktop** if you plan to run the full stack or indexer locally. Node includes `npm`, and `npm run setup` installs Bun automatically if it is missing.

**Optional tools:** Foundry is needed for contract work. `cloudflared` is useful for mobile-device PWA testing. macOS and Linux are supported natively; use WSL2 or a dev container on Windows.

### Clone

[![Clone on GitHub](https://img.shields.io/badge/Clone-on%20GitHub-2da44e?logo=github)](https://github.com/greenpill-dev-guild/green-goods)

Use GitHub's **Code** button to choose the SSH or HTTPS remote that matches your local Git setup. Then run the setup commands from the repo root.

### Agent-Assisted Setup

If you are using Codex, Claude Code, or another coding agent, start by loading [ONBOARDING.md](./ONBOARDING.md). It gives the agent the repo context, setup flow, environment model, and first-run checks before it starts changing files.

```text
Read ONBOARDING.md and AGENTS.md, then walk me through first-time setup for this repo.
Start with prerequisites, run npm run setup, check web readiness, start the browser
stack, and explain any env blockers before making changes.
```

### Setup

#### Install dependencies

```bash
npm run setup
```

After setup, use `bun` for repo scripts and package operations. `npm run setup` is the only documented npm entrypoint because fresh machines may not have Bun yet.

#### Environment defaults

Green Goods uses a single root `.env`, materialized from `.env.template` via the [1Password CLI](https://developer.1password.com/docs/cli/) (`op inject`). Bun, Vite, and Node read it natively — no per-command secret fetch.

```bash
bun run env:template:init   # one-time: scaffold .env.template from .env.schema
bun run env:sync             # materialize .env from .env.template (runs `op inject`)
bun run env:check            # validate .env satisfies .env.schema
```

`.env.schema` defines the contract; `.env.template` is the team-shared file with `op://Vault/Item/field` refs for shared secrets and plain values for non-secrets. Keep personal local-only credentials directly in `.env`.

| Variable | Needed for | Default setup state |
| --- | --- | --- |
| `APP_ENV` | Local tooling mode | Generated as `development` |
| `VITE_CHAIN_ID` | Client/admin chain selection | Generated for Sepolia |
| `VITE_ENVIO_INDEXER_URL` | Local indexer reads | Generated for local GraphQL; needs the indexer running for live local data |
| `VITE_PINATA_JWT` | Upload-capable media | Add only when testing uploads |
| `VITE_PIMLICO_API_KEY` | Passkey auth | Add only when testing passkey flows |
| `VITE_WALLETCONNECT_PROJECT_ID` | Wallet auth | Add only when testing wallet flows |
| `TELEGRAM_BOT_TOKEN` | Agent service | Add only when running a useful local agent |

For shared team secrets, edit `.env.template` and set the value to `op://Vault/Item/field`, then run `bun run env:sync`. For personal local credentials, set the variable directly in the root `.env`. Never create package-level `.env` files.

### Check readiness

```bash
bun run dev:doctor -- --profile web
```

### Start stack

```bash
bun run dev:web
```

Starts the four browser-based surfaces: client, admin, docs, and Storybook.

### Testing

```bash
bun run dev:smoke:web
```

Run this after the browser stack is starting.

## Tech Stack

### Stack Overview

- Node.js 22+ provides `npm` for first-clone setup.
- `npm run setup` installs Bun, installs dependencies, and creates the root `.env`.
- Bun is the workspace runtime after setup.
- `.env.schema` (key contract) + `.env.template` (1Password refs) materialize `.env` via `bun run env:sync` (`op inject`).
- PM2 manages local dev services.
- Docker powers full-stack indexer development.
- Storybook runs from the shared package.
- Full-stack work adds Docker-backed indexer services, the agent, tunnel, and workflow-specific env or secrets.

### Core Local URLs

Client and admin can start with generated defaults. Live data, uploads, authenticated onchain flows, and the local agent depend on the matching env and services.

| Surface | URL | Started by |
| --- | --- | --- |
| Client |  | `bun run dev:web` or `bun run dev` |
| Admin |  | `bun run dev:web` or `bun run dev` |
| Docs |  | `bun run dev:web` or `bun run dev` |
| Storybook |  | `bun run dev:web` or `bun run dev` |
| Agent |  | `bun run dev` with configured agent env |
| Indexer |  | `bun run dev` with Docker running |

### Dev Commands

#### Start browser surfaces

```bash
bun run dev:web
```

Runs the four browser-based sites: client, admin, docs, and Storybook.

#### Start full local stack

Check full-stack readiness first:

```bash
bun run dev:doctor -- --profile full
```

Then start the full stack:

```bash
bun run dev
```

Use the full stack for Docker/indexer, agent, tunnel, or mobile-device PWA work. Run the full doctor first; some services need workflow-specific env or secrets before they are useful.

#### Stop local services

```bash
bun run dev:stop
```

## Contributing

### Guides

Read the [Greenpill Dev Guild contributing guide](https://github.com/greenpill-dev-guild/.github/blob/main/CONTRIBUTING.md) and the full [How to Contribute](https://docs.greengoods.app/builders/how-to-contribute) guide before opening a pull request.

### Before Pushing

Run each command from the repo root before pushing.

#### Check formatting

```bash
bun run format:check
```

#### Run lint

```bash
bun run lint
```

#### Run tests

```bash
bun run test
```

#### Build workspace

```bash
bun run build
```

### Funded Scoped Work

Paid implementation work is grant-dependent and must be clearly scoped with maintainers before work begins. Green Goods does not run open-ended bounties.

## Resources

### Documentation

- [Developer Getting Started](https://docs.greengoods.app/builders/getting-started) - setup, env bootstrap, local services, and first-run workflow
- [Architecture](https://docs.greengoods.app/builders/architecture) - system design, boundaries, and diagrams
- [Builder API Index](https://docs.greengoods.app/builders/packages/api-index) - package APIs, contracts, and shared surfaces
- [Operations](https://docs.greengoods.app/builders/operations) - build, deploy, environment, and workflow references
- [How to Contribute](https://docs.greengoods.app/builders/how-to-contribute) - contributor workflow and expectations

### Agent References

- [ONBOARDING.md](./ONBOARDING.md) - paste into Claude Code on day one for a guided setup walkthrough
- [AGENTS.md](./AGENTS.md) - runtime rules and repo invariants for Codex and other coding agents
- [CLAUDE.md](./CLAUDE.md) - Claude Code commands, patterns, and working conventions

### Community and Security

- [Code of Conduct](https://github.com/greenpill-dev-guild/.github/blob/main/CODE_OF_CONDUCT.md)
- [Security Policy](https://github.com/greenpill-dev-guild/.github/blob/main/SECURITY.md)
- [MIT License](./LICENSE)

        

---

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

• Delete event: 60
• Pull request event: 143
• Fork event: 3
• Issues event: 486
• Watch event: 10
• Issue comment event: 181
• Push event: 407
• Pull request review comment event: 186
• Pull request review event: 159
• Create event: 85
• Commit comment event: 50

Last Year

• Delete event: 59
• Pull request event: 128
• Fork event: 2
• Issues event: 467
• Watch event: 5
• Issue comment event: 171
• Push event: 350
• Pull request review comment event: 186
• Pull request review event: 144
• Create event: 78
• Commit comment event: 40

---

Committers metadata

Last synced: 4 days ago

Name	Email	Commits
Afo	c****t@a****o	1524
0xWildhare	s****9@g****m	31
Tarun Gupta	t****r@r****m	18
copilot-swe-agent[bot]	1****t	16
dependabot[bot]	4****]	7
Cursor Agent	c****t@c****m	6
Athus	a****o@g****m	5
Alexander Mangel	c****r@g****m	3
Claude	n****y@a****m	2
mrcn	m****a@g****m	1

Committer domains:

• anthropic.com: 1
• cursor.com: 1
• rediffmail.com: 1
• afolabi.info: 1

---

Issue and Pull Request metadata

Last synced: 5 days ago

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

---

---

---

Package metadata

• Total packages: 1
• Total downloads: unknown
• Total dependent packages: 0
• Total dependent repositories: 0
• Total versions: 1

Score: -Infinity