Documentation
Everything you need to run, use and extend EcoPilot AI.
Quick start
# install
npm install
# develop
npm run dev
# production build
npm run build && npm start
- 1. Open Settings and connect any OpenAI-compatible provider (OpenAI, OpenRouter, Groq, DeepSeek, Together, Ollama…).
- 2. Press Test connection — a green badge confirms the endpoint responds.
- 3. Run the Carbon Calculator once to seed your dashboard.
Feature guides
AI Advisor
Streaming Q&A grounded in emission factors. Conversations are saved locally and resumable.
Carbon Calculator
Monthly inputs across 8 categories; results include benchmarks, charts and ranked suggestions.
Waste Classifier
Vision-based classification into 7 categories with disposal steps. Works best with gpt-4o-mini class models.
Habits & Challenges
Streaks, achievements and AI-generated weekly challenge sets tailored to your audience.
Climate Explorer
Four bundled datasets (NOAA, NASA, OWID) with range filtering, regression trends and CSV export.
Reports & Analysis
Report generation, document summarization and in-browser CSV analysis with anomaly detection.
Architecture at a glance
- • app/ — App Router pages; workspace routes share a persistent shell.
- • lib/ai/client.ts — one typed client for every OpenAI-compatible endpoint (streaming SSE included).
- • services/ — pure domain logic (carbon math, streaks, storage) that is unit-tested without React.
- • contexts/ + providers/ — settings, toasts, theme; React Query for async provider checks.
- • data/ — bundled climate datasets and demo seeds; zero external API dependencies.
Full developer documentation lives in the repository under /docs.