README.md

Pokzi

Pokzi is a playful, iPad-first Pokemon search app for children.

Find Pokemon in seconds:

• Type a German name (schiggy)
• Or type a number (7)
• Keep finding results even with umlaut/ss variants or small typos
• Get clear, touch-friendly cards instantly
• Open a dedicated detail view for one Pokemon

Built to feel easy for children and maintainable for teams.

For Parents

• Child-friendly search flow with immediate feedback.
• Large, easy-to-tap controls for tablet use.
• German UI text throughout.
• Dedicated detail page with focused artwork, clear key facts, and a stage-based evolution board.
• Clear messages for loading, no results, and errors.

For Developers

• Svelte + TypeScript + Vite baseline.
• Service-driven API layer (src/services) for testability.
• Strong quality gates (lint, type-check, unit tests, E2E smoke tests).
• TSDoc/JSDoc enforced for key TypeScript structures.
• Optional local specialist skills and repo-defined agents for escalated workflows.

Quick Start

1. npm install
2. npm run dev

Repo Docs

• Repo docs overview: CONCEPT.md
• Structured repo docs: docs/repo/
• Architecture and refactor planning docs: docs/architecture/
• Visual/UI direction: DESIGN_BRIEF.md
• Engineering/agent rules: AGENTS.md
• Agent delivery decisions: docs/architecture/2026-03-07-agent-delivery-system-decision.md, docs/architecture/2026-04-12-token-efficient-agentic-delivery-decision.md
• High-level framing: INSTRUCTIONS.md

Developer Notes

• Markdown docs and code comments are English.
• User-facing UI copy remains German.
• Agent chat with the user remains German unless requested otherwise.
• Detail deep-links use hash routing (#/pokemon/:id) for GitHub Pages compatibility.

Useful Commands

• npm run lint
• npm run format:check
• npm run check
• npm test
• npm run test:e2e
• npm run index:de:check
• npm run index:de:update

CI note:

• .github/workflows/quality.yml enforces the DE index drift check on pull requests and pushes to main.