AGENTS.md

This file provides guidance to AI agents (OpenCode, Claude Code, etc.) when working with code in this repository.

Project Overview

Interactive CV/portfolio website for Andy Charlwood with a distinctive loading experience: terminal boot sequence → ECG canvas animation with name tracing. Built as a React SPA with TypeScript and Vite.

Commands

npm run dev — Start dev server (localhost:5173)
npm run build — TypeScript compile + Vite production build
npm run typecheck — TypeScript type checking only (tsc --noEmit)
npm run lint — ESLint
npm run preview — Preview production build

No test framework is configured.

Architecture

Loading UI Flow

App.tsx manages a Phase state ('boot' → 'ecg'). Each phase renders exclusively:

BootSequence — Terminal typing animation (~4s), green-on-black aesthetic
ECGAnimation — Canvas-based heartbeat animation (~5-6s) with letter tracing, background transitions from black to white

Total boot-to-ECG completion time must be ≤10 seconds.

Key Patterns

Canvas ECG: ECGAnimation.tsx does imperative canvas drawing with requestAnimationFrame — flatline → 3 heartbeats (40px→60px→100px) → letter tracing → exit.

Path Aliases

@/ maps to ./src/ (configured in both vite.config.ts and tsconfig.json).

Styling

Tailwind CSS with custom design tokens in tailwind.config.js:

Colors: teal #00897B (primary), coral #FF6B6B (accent), ECG palette (green/cyan/dim)
Fonts: Plus Jakarta Sans (primary), Inter Tight (secondary), Fira Code (mono/terminal)
Breakpoints: xs 480px, sm 640px, md 768px, lg 1024px, xl 1280px

Type System

All data types live in src/types/index.ts. Strict TypeScript — no any types. One component per file with typed props interfaces.

Guardrails

Boot sequence text and colors must match References/concept.html exactly (CLINICAL TERMINAL v3.2.1 format).
ECG animation timing/amplitudes/color transitions must match the concept reference.
When writing components with visual styling or animations, invoke the frontend-design skill first.

Available Skills

This project has access to the following agent skills in .agents/skills/:

frontend-design — Use for any visual styling or animation work

Project Structure

src/
├── components/    # One component per file (PascalCase)
├── hooks/         # Custom hooks (camelCase, use* prefix)
├── lib/           # Utility functions
├── types/         # TypeScript interfaces
├── App.tsx        # Phase manager (root component)
└── index.css      # Global styles + Tailwind directives
Ralph/             # Implementation plan, guardrails, progress tracking
References/        # Source content (concept.html, ECGVideo/)

2.8 KiB Raw Blame History