## File: README.md --- ## Demo [](https://youtu.be/O669pVZ_qr0) > Click the image above to watch the full demo on YouTube. ## Quick Start > **Important:** Start by making your own copy with GitHub's **Use this template** button. Do not clone this template repository directly for your website project, and do not open pull requests here with your generated website. 1. **Create your own repository from this template** On the GitHub page for this project, click **Use this template**, then click **Create a new repository**. Give your new repository a name, choose whether it should be public or private, then click **Create repository**. If GitHub shows an **Include all branches** option, you can leave it off. This gives you your own separate project to work in, so your website changes stay in your account instead of coming back to the main template. 2. **Open your new repository on your computer** After GitHub creates your copy, open that new repository. Click **Code** and open or clone your new repository with your preferred coding tool. If you use the terminal, the command will look like this: ```bash git clone https://github.com/YOUR-USERNAME/YOUR-NEW-REPOSITORY.git cd YOUR-NEW-REPOSITORY ``` 3. **Install dependencies** ```bash npm install ``` 4. **Start your AI agent** — Claude Code recommended: ```bash claude --chrome ``` 5. **Run the skill**: ``` /clone-website [ ...] ``` 6. **Customize** (optional) — after the base clone is built, modify as needed > Most supported clients expose `/clone-website` directly. If your client activates skills from natural-language requests, enter `Clone using the clone-website workflow`. Project instructions are in `AGENTS.md`. ## Supported Platforms | Agent | Status | | ------------------------------------------------------------- | -------------------------- | | [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | **Recommended** — Opus 5 | | [Codex CLI](https://github.com/openai/codex) | Supported | | [OpenCode](https://opencode.ai/) | Supported | | [GitHub Copilot](https://github.com/features/copilot) | Supported | | [Kiro](https://kiro.dev/) | Supported | | [Cursor](https://cursor.com/) | Supported | | [Windsurf](https://codeium.com/windsurf) | Supported | | [Gemini CLI](https://github.com/google-gemini/gemini-cli) | Supported | | [Cline](https://github.com/cline/cline) | Supported | | [Roo Code](https://github.com/RooCodeInc/Roo-Code) | Supported | | [Continue](https://continue.dev/) | Supported | | [Amazon Q](https://aws.amazon.com/q/developer/) | Supported | | [Augment Code](https://www.augmentcode.com/) | Supported | ## Prerequisites - [Node.js](https://nodejs.org/) 24+ - An AI coding agent (see [Supported Platforms](#supported-platforms)) ## Tech Stack - **Next.js 16** — App Router, React 19, TypeScript strict - **shadcn/ui** — Radix primitives + Tailwind CSS v4 - **Tailwind CSS v4** — oklch design tokens - **Lucide React** — default icons (replaced by extracted SVGs during cloning) ## How It Works The `/clone-website` skill runs a multi-phase pipeline: ```mermaid flowchart LR P1["1. Reconnaissance"] --> P2["2. Foundation"] P2 --> P3["3. Component Specs"] P3 --> P4["4. Parallel Build"] P4 --> P5["5. Assembly and QA"] ``` 1. **Reconnaissance** — screenshots, design token extraction, interaction sweep (scroll, click, hover, responsive) 2. **Foundation** — updates fonts, colors, globals, downloads all assets 3. **Component Specs** — writes detailed spec files (`docs/research/components/`) with exact computed CSS values, states, behaviors, and content 4. **Parallel Build** — dispatches builder agents in git worktrees, one per section/component 5. **Assembly & QA** — merges worktrees, wires up the page, runs visual diff against the original Each builder agent receives the full component specification inline — exact `getComputedStyle()` values, interaction models, multi-state content, responsive breakpoints, and asset paths. No guessing. ## Use Cases - **Platform migration** — rebuild a site you own from WordPress/Webflow/Squarespace into a modern Next.js codebase - **Lost source code** — your site is live but the repo is gone, the developer left, or the stack is legacy. Get the code back in a modern format - **Learning** — deconstruct how production sites achieve specific layouts, animations, and responsive behavior by working with real code ## Not Intended For - **Phishing or impersonation** — this project must not be used for deceptive purposes, impersonation, or any activity that breaks the law. - **Passing off someone's design as your own** — logos, brand assets, and original copy belong to their owners. - **Violating terms of service** — some sites explicitly prohibit scraping or reproduction. Check first. ## Project Structure ``` src/ app/ # Next.js routes components/ # React components ui/ # shadcn/ui primitives icons.tsx # Extracted SVG icons lib/utils.ts # cn() utility types/ # TypeScript interfaces hooks/ # Custom React hooks public/ images/ # Downloaded images from target videos/ # Downloaded videos from target seo/ # Favicons, OG images docs/ research/ # Extraction output & component specs design-references/ # Screenshots scripts/ sync-agent-rules.sh # Regenerate agent instruction files sync-skills.mjs # Regenerate /clone-website for all platforms .kiro/skills/ # Generated Kiro workspace skill .cline/skills/ # Generated Cline workspace skill .roo/skills/ # Generated Roo Code workspace skill .roo/commands/ # Generated Roo Code slash command AGENTS.md # Agent instructions (single source of truth) CLAUDE.md # Claude Code config (imports AGENTS.md) GEMINI.md # Gemini CLI config (imports AGENTS.md) ``` ## Commands ```bash npm run dev # Start dev server npm run build # Production build npm run lint # ESLint check npm run typecheck # TypeScript check npm run check # Run lint + typecheck + build ``` ### If using docker ```bash docker compose up app --build # build and run the app docker compose up dev --build # run the app in dev mode on port 3001 ``` ## Updating for Other Platforms Two source-of-truth files power all platform support. Edit the source, then run the sync script: | What | Source of truth | Sync command | | ---------------------- | --------------------------------------- | ---------------------------------- | | Project instructions | `AGENTS.md` | `bash scripts/sync-agent-rules.sh` | | `/clone-website` skill | `.claude/skills/clone-website/SKILL.md` | `node scripts/sync-skills.mjs` | Each script regenerates the platform-specific copies automatically. Agents that read the source files natively need no regeneration. ## Star History ## License MIT Translations: [日本語](README.ja.md) · [Simplified Chinese](README.zh-CN.md) --- ## File: docs/research/INSPECTION_GUIDE.md # Website Inspection Guide ## How to Reverse-Engineer Any Website This guide outlines what to capture when inspecting a target website via Chrome MCP or browser DevTools. ## Phase 1: Visual Audit ### Screenshots to Capture - [ ] Every distinct page — desktop, tablet, mobile - [ ] Dark mode variants (if applicable) - [ ] Light mode variants (if applicable) - [ ] Key interaction states (hover, active, open menus, modals) - [ ] Loading/skeleton states - [ ] Empty states - [ ] Error states ### Design Tokens to Extract - [ ] **Colors** — background, text (primary/secondary/muted), accent, border, hover, error, success, warning - [ ] **Typography** — font family, sizes (h1-h6, body, caption, label), weights, line heights, letter spacing - [ ] **Spacing** — padding/margin patterns (look for a scale: 4px, 8px, 12px, 16px, 24px, 32px, etc.) - [ ] **Border radius** — buttons, cards, avatars, inputs - [ ] **Shadows/elevation** — card shadows, dropdown shadows, modal overlay - [ ] **Breakpoints** — when does the layout shift? (inspect with DevTools responsive mode) - [ ] **Icons** — which icon library? custom SVGs? sizes? - [ ] **Avatars** — sizes, shapes, fallback behavior - [ ] **Buttons** — all variants (primary, secondary, ghost, icon-only, danger) - [ ] **Inputs** — text fields, textareas, selects, checkboxes, toggles ## Phase 2: Component Inventory For each distinct UI component, document: 1. **Name** — what would you call this component? 2. **Structure** — what HTML elements / child components does it contain? 3. **Variants** — does it have different sizes, colors, or states? 4. **States** — default, hover, active, disabled, loading, error, empty 5. **Responsive behavior** — how does it change at different breakpoints? 6. **Interactions** — click, hover, focus, keyboard navigation 7. **Animations** — transitions, entrance/exit animations, micro-interactions ### Common Components to Look For - Navigation (top bar, sidebar, bottom bar) - Cards / list items - Buttons and links - Forms and inputs - Modals and dialogs - Dropdowns and menus - Tabs and segmented controls - Avatars and user badges - Loading skeletons - Toast notifications - Tooltips and popovers ## Phase 3: Layout Architecture - [ ] **Grid system** — CSS Grid? Flexbox? Fixed widths? - [ ] **Column layout** — how many columns at each breakpoint? - [ ] **Max-width** — main content area max-width - [ ] **Sticky elements** — header, sidebar, floating buttons - [ ] **Z-index layers** — navigation, modals, tooltips, overlays - [ ] **Scroll behavior** — infinite scroll, pagination, virtual scrolling ## Phase 4: Technical Stack Analysis - [ ] **Framework** — React? Vue? Angular? Check `__NEXT_DATA__`, `__NUXT__`, `ng-version` - [ ] **CSS approach** — Tailwind (utility classes), CSS Modules, Styled Components, Emotion, vanilla CSS - [ ] **State management** — Redux (check DevTools), React Query, Zustand, Pinia - [ ] **API patterns** — REST, GraphQL (check network tab for `/graphql` requests) - [ ] **Font loading** — Google Fonts, self-hosted, system fonts - [ ] **Image strategy** — CDN, lazy loading, srcset, WebP/AVIF - [ ] **Animation library** — Framer Motion, GSAP, CSS transitions only ## Phase 5: Documentation Output After inspection, create these files in `docs/research/`: 1. `DESIGN_TOKENS.md` — All extracted colors, typography, spacing 2. `COMPONENT_INVENTORY.md` — Every component with structure notes 3. `LAYOUT_ARCHITECTURE.md` — Page layouts, grid system, responsive behavior 4. `INTERACTION_PATTERNS.md` — Animations, transitions, hover states 5. `TECH_STACK_ANALYSIS.md` — What the site uses and our chosen equivalents