Energy Bill Lab

Energy Bill Lab is a public-first U.S. home-energy utility website. It helps U.S. residents understand high electricity bills, estimate appliance operating costs, compare state electricity rates, and review transparent methodology and source notes.

Current Status

Energy Bill Lab is a production-ready monorepo featuring:

• State Electricity Rate Pages (50 of 50 States): Full coverage across all 50 U.S. states (/electricity-rates/[state]), backed by official PostgreSQL U.S. EIA monthly data provenance, state regulatory sources, and dynamic research report integration.
• Energy Calculators (10): Electricity Bill Analyzer, Appliance Energy Cost Calculator, Air Conditioner Cost Calculator, Space Heater Cost Calculator, EV Home Charging Cost Calculator, Refrigerator Cost Calculator, Clothes Dryer Cost Calculator, Electric Water Heater Cost Calculator, Pool Pump Cost Calculator, and Dehumidifier Cost Calculator.
• Problem-Solving Energy Guides (50): 50 high-intent energy guides providing diagnostic advice, appliance power consumption benchmarks, inline citations, and calculator integration.
• Original Research & Data Export (1): National U.S. Residential Electricity-Rate Report (/research/us-residential-electricity-rate-report) dynamically linking all 50 states, plus safe CSV data export (/research/us-residential-electricity-rate-report/csv).
• Trust & Policy System: About, Contact, Editorial Policy, Data Sources (with Data Update History log), Methodology, Accessibility, Privacy Policy, Terms of Service, Disclaimer, Cookies.
• Canonical Favicon & Social Preview: Next.js App Router canonical metadata files (/favicon.ico, /icon.png, /apple-icon.png, /opengraph-image.png, /twitter-image.png) with zero public duplicate assets and https://energybilllab.com/ metadata base.
• Author Identity & Privacy: Direct publisher attribution to Jaynesh Shingala (shingala.jaynesh@gmail.com) across guides, research reports, and JSON-LD schemas, with strict exclusion of personal location or software developer titles.
• AI Crawler Controls: robots.txt configured with explicit rules allowing OAI-SearchBot and ChatGPT-User for search discovery while blocking GPTBot.
• Backend API & Data Sync: NestJS API service with Fastify adapter, PostgreSQL Drizzle ORM, and terminal/CLI EIA monthly data importer (pnpm --filter=@energy-bill-lab/api eia:sync-latest).

Monorepo Overview

This is a pnpm and Turborepo TypeScript monorepo.

apps/
  web/      Next.js App Router public website (137 prerendered static pages)
  api/      NestJS Fastify API service and EIA ingestion sync job
packages/
  calculation-engine/  Pure calculation formulas package (100% unit tested)
  contracts/           Shared Zod schemas and API types
  database/            Neon PostgreSQL schema, Drizzle client, migrations
  design-system/       Ant Design theme tokens and product constants
  eslint-config/       Shared ESLint flat config
  testing/             Shared test helpers
  typescript-config/   Shared strict TypeScript configs
docs/                  Human-facing project documentation
.ai/                   Agent instructions, active task context, ADRs, and prompts

Technology Stack

• Package management: pnpm
• Task orchestration: Turborepo
• Language: TypeScript
• Web: Next.js App Router, React, Ant Design, CSS Modules, @next/third-parties
• API: NestJS with Fastify
• Validation: Zod shared contracts
• Database: Neon PostgreSQL with Drizzle ORM
• Frontend hosting: Vercel
• API/jobs hosting: Render

Prerequisites

• Node.js 22 or newer
• pnpm compatible with the root packageManager

Installation

pnpm install

Environment Setup

Use tracked examples only as placeholders:

• .env.example
• apps/web/.env.example
• apps/api/.env.example

Copy the relevant values into local ignored environment files (.env.local). Never commit real credentials.

Development Commands

pnpm dev
pnpm build
pnpm build:web
pnpm build:api

Validation Commands

pnpm install --frozen-lockfile
pnpm format:check
pnpm typecheck
pnpm lint
pnpm test
pnpm build:web
pnpm build:api

Application Locations

• Web app: apps/web
• API app: apps/api
• Shared packages: packages

See apps/web/README.md and apps/api/README.md for application-specific notes.

Documentation Links

• Documentation index: docs/README.md
• Product documentation: docs/product/
• Appliance expansion calculators: docs/product/appliance-expansion-calculators.md
• Production readiness report: docs/operations/production-readiness.md
• Local setup: docs/development/local-setup.md
• Repository structure: docs/development/repository-structure.md
• Testing and validation: docs/development/testing.md
• Deployment: docs/operations/deployment.md
• Environment variables: docs/operations/environment-variables.md
• SEO and AdSense notes: docs/seo-adsense/seo-and-adsense.md

AI-Agent Instructions

All agents must start with AGENTS.md, then read .ai/BRAIN.md, .ai/PROJECT_PLAN.md, and .ai/ACTIVE_TASK.md.

Completed prompts in .ai/prompts/completed/ are historical records. Do not execute them again.

Security & Privacy

• PostgreSQL driver SSL connection mode warnings are accepted, non-fatal library warnings. packages/database/src/clients/db-client.ts, apps/web/package.json, turbo.json, vercel.json, and render.yaml are protected files.
• Zero user financial metrics, bill amounts, kWh values, rates, or geographic state names are transmitted in analytics events.

Contribution Workflow

1. Read CONTRIBUTING.md.
2. Audit existing implementation before editing.
3. Search for existing functionality before creating new files.
4. Keep the change scoped to one coherent purpose.
5. Update tests and documentation when behavior or architecture changes.
6. Run required validation (pnpm format:check ; pnpm typecheck ; pnpm lint ; pnpm test ; pnpm build:web ; pnpm build:api).
7. Commit with type(scope): concise description.