Installation & Environment Setup

Complete setup guide for local Green Goods development.

Prerequisites

Required

Node.js: v20+ (nodejs.org)
Bun: v1.0+ (bun.sh)
Git: Version control
Docker Desktop: For indexer (docker.com)

Blockchain Development

Foundry: Forge, Cast, Anvil (getfoundry.sh)

Optional

MetaMask: For operator testing
VS Code: Recommended editor with Biome extension

Installation Steps

1. Clone Repository

git clone https://github.com/greenpill-dev-guild/green-goods.git
cd green-goods

2. Install Dependencies

bun install

Installs all packages: client, admin, indexer, contracts.

3. Configure Environment

cp .env.example .env

Edit .env with required keys:

# Client - Required
VITE_WALLETCONNECT_PROJECT_ID=your_reown_project_id
VITE_PIMLICO_API_KEY=your_pimlico_key
VITE_CHAIN_ID=84532  # Base Sepolia default

# Contracts - Optional for running client
FOUNDRY_KEYSTORE_ACCOUNT=green-goods-deployer
BASE_SEPOLIA_RPC_URL=https://sepolia.base.org

# Optional
VITE_PINATA_JWT=your_pinata_jwt
ETHERSCAN_API_KEY=your_etherscan_key

Get API Keys:

4. Start Development

bun dev

Services start:

Client: https://localhost:3001
Admin: http://localhost:3002
Indexer: http://localhost:8080

Package-Specific Setup

Client

bun --filter client dev

HTTPS Localhost: Uses mkcert for PWA testing.

Admin

bun --filter admin dev

Indexer

Ensure Docker running first:

open -a Docker  # macOS
# Wait 30 seconds
bun --filter indexer dev

Contracts

Import keystore (one-time):

cast wallet import green-goods-deployer --interactive

Compile:

bun --filter contracts build

Test:

bun --filter contracts test

Verification

Check services:

bun exec pm2 status

View logs:

bun exec pm2 logs client

Stop all:

bun dev:stop

Troubleshooting

Port conflicts:

lsof -i :3001  # Find process
kill -9 <PID>  # Kill it

Docker issues:

bun --filter indexer reset

Dependency issues:

rm -rf node_modules bun.lock
bun install

Learn More

PreviousOverview for Builders NextMonorepo Structure

Last updated 23 days ago