AGENTS.md

1# Repository Guidelines
2 
3## Project Structure & Module Organization
4 
5- Frontend (Next.js + TypeScript): `src/app/**` (pages: `page.tsx`, `layout.tsx`, styles: `globals.css`). API route for CopilotKit: `src/app/api/copilotkit/route.ts`.
6- Agent (ADK/Python): `agent/agent.py`, virtual env in `agent/.venv`, deps in `agent/requirements.txt`.
7- Public assets: `public/`. Config: `next.config.ts`, `tsconfig.json`, `eslint.config.mjs`.
8- Scripts: `scripts/run-agent.sh`, `scripts/setup-agent.sh`.
9 
10## Build, Test, and Development
11 
12- `npm run dev` — runs UI (`next dev --turbopack`) and the Python agent concurrently.
13- `npm run dev:ui` — frontend only; useful for UI iteration.
14- `npm run dev:agent` — agent only; activates `.venv` and runs `agent.py`.
15- `npm run build` — production build for the Next.js app.
16- `npm start` — serve the built app.
17- `npm run lint` — lint the frontend with Next/ESLint.
18- First-time setup installs the agent via `postinstall` (creates `.venv` and installs Python deps).
19 
20## Coding Style & Naming Conventions
21 
22- TypeScript/React: 2-space indent, PascalCase components, camelCase variables, file-based routing under `src/app/**`.
23- Python agent: follow PEP 8; keep modules small and composable.
24- Linting: Next.js ESLint config (`npm run lint`). Prefer explicit types in exported APIs.
25- Components: colocate with usage; export from an `index.ts` when creating reusable modules.
26 
27## Testing Guidelines
28 
29- Currently no test harness. When adding tests:
30  - Frontend: Jest/Vitest in `src/__tests__/` with `*.test.ts(x)`.
31  - Agent: `pytest` in `agent/tests/` with `test_*.py`.
32  - Aim for high coverage on data shaping (dashboard spec generation, adapters).
33 
34## Commit & Pull Request Guidelines
35 
36- Conventional Commits: `type(scope): message`.
37  - Types: `feat`, `fix`, `docs`, `refactor`, `test`, `chore`, `ci`.
38  - Example: `feat(charts): support pie charts`.
39- PRs: clear description, linked issue, before/after screenshots or JSON spec samples, and testing notes.
40- Keep PRs focused; call out env/config changes explicitly.
41 
42## Environment, Security & Config
43 
44- Place secrets in `.env.local` (frontend) and `agent/.env` (agent). Never commit secrets.
45- Example keys (adjust to your provider):
46  - Frontend: `NEXT_PUBLIC_CPK_ENDPOINT=/api/copilotkit`.
47  - Agent: `GOOGLE_API_KEY=...` (Gemini), or `OPENAI_API_KEY=...` if applicable.
48- Validate/sanitize prompts; avoid logging PII. Prefer `INFO` logs with redaction.
49 
50## Charts & CopilotKit Tips
51 
52- Dashboard spec (example): `{ "type": "line", "title": "Revenue", "x": "date", "y": "revenue" }`.
53- Supported types to target in UI: `line`, `bar`, `pie`
54- Naming: use singular `x`/`y` for series
55- Recharts via CPK: map spec→props; e.g., `LineChart` with `dataKey={spec.y}` and `XAxis dataKey={spec.x}`;
56 
57## Architecture Overview
58 
59- Next.js app hosts CopilotKit UI and API route; Python agent performs ADK/Gemini orchestration. `npm run dev` runs both together.
60