launchframe 0.4.8 → 0.4.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/AGENTS.md CHANGED
@@ -33,9 +33,9 @@ A reusable template for reverse-engineering any website into a clean, modern Nex
33
33
  ## Design Principles
34
34
  - **Pixel-perfect emulation** — match the target's spacing, colors, typography exactly
35
35
  - **No personal aesthetic changes during emulation phase** — match 1:1 first, customize later
36
- - **Real content** — use actual text and assets from the target site where they are interchangeable chrome; **`/launchframe`** overlays your SaaS pitch on headings and CTAs. **Marketing photographs and illustrative hero/feature imagery are not photocopied**: recreate each visual slot with **new images** scoped to **your product** (same framing, hierarchy, and aspect ratio detail insets / secondary crops should echo the reference layout but show product-relevant subjects), and note originals vs substitutes in `docs/research/`
36
+ - **Real content** — use actual text and assets from the target site where they are interchangeable chrome; **`/launchframe`** overlays your SaaS pitch on headings and CTAs. **Marketing photographs and illustrative hero/feature imagery are not photocopied**: you **must** ship **committed files** under `public/images/` (etc.) for every such slot **generate them yourself** with your host **image-generation** tool (prompts tied to the SaaS idea), wire into components, supplement with UI mock composites only if helpful. Blank placeholders count as unfinished. Record paths in `docs/research/LAUNCHFRAME.md`
37
37
  - **Beauty-first** — every pixel matters
38
- - **DOM crawl priority** — when walking the target page, emphasize **images** (raster, responsive sources, CSS backgrounds), **SVGs** (inline icons, sprites, masks — **copy extracted geometry**, do not approximate with unrelated Lucide glyphs), then **motion** (**copy** `@keyframes`, `transition`/`animation` timings, scroll triggers, carousel staggers via Chrome MCP / CSS sources). **Measure and mirror** mounting and styling from the DOM; scrape **permission-neutral** bytes when appropriate. When a raster slot must be original for brand safety, **author** replacements and label them in research notes — **that never waives SVG or animation fidelity**
38
+ - **Inspection workflow (canonical)** — Follow the ordered **five steps** in `docs/research/INSPECTION_GUIDE.md`: (1) **Structure** — DOM as hierarchy reference, not pasted production HTML; (2) **Styles**Computed/stylesheets and tokens; (3) **Motion** — `@keyframes`, transitions, timings, triggers; (4) **Assets** — rasters/SVGs with brand-safe originals for marketing slots when required; (5) **Implementation** — Next.js components rebuild. Within crawls (Chrome MCP / DevTools), still emphasize **images** (raster, responsive sources, CSS backgrounds), **SVGs** (inline, sprites, masks — **exact geometry**, not unrelated Lucide stand-ins), then **motion fidelity**. **Measure and mirror** from the DOM; scrape **permission-neutral** bytes when appropriate **SVG and animation fidelity are not waived** when rasters are replaced
39
39
 
40
40
  ## Project Structure
41
41
  ```
@@ -60,6 +60,7 @@ scripts/ # Asset download scripts
60
60
 
61
61
  ## MOST IMPORTANT NOTES
62
62
  - When launching Claude Code agent teams, ALWAYS have each teammate work in their own worktree branch and merge everyone's work at the end, resolving any merge conflicts smartly since you are basically serving the orchestrator role and have full context to our goals, work given, work achieved, and desired outcomes.
63
+ - **`/launchframe` Phase 6 verification** must always run: prompt text lives in **`docs/research/LAUNCHFRAME_SUBAGENTS.md`**; results in **`docs/research/LAUNCHFRAME_VERIFICATION.md`**. Use four parallel **Task**/subagents (paste one `## Prompt — Pass …` section per agent) or run all four sequentially yourself — never skip verification.
63
64
  - After editing `AGENTS.md`, run `bash scripts/sync-agent-rules.sh` to regenerate platform-specific instruction files.
64
65
  - After editing **any** `SKILL.md` under `.claude/skills/<skill-id>/`, run `node scripts/sync-skills.mjs` to regenerate that skill’s slash commands/workflows for **every supported platform** (discovered automatically).
65
66
 
package/README.md CHANGED
@@ -1,165 +1,38 @@
1
- # Launchframe (AI Website Cloner)
2
-
3
- <a href="https://github.com/JCodesMore/ai-website-cloner-template/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="MIT License" /></a> <a href="https://github.com/JCodesMore/ai-website-cloner-template/stargazers"><img src="https://img.shields.io/github/stars/JCodesMore/ai-website-cloner-template?style=flat" alt="Stars" /></a> <a href="https://discord.gg/hrTSX5yTpB"><img src="https://img.shields.io/discord/1400896964597383279?label=discord" alt="Discord" /></a>
4
-
5
- **`/launchframe`** — full pixel-perfect reverse-engineer of the reference page **plus** a SaaS pitch (two parameters: URL and quoted idea). Config is stored in `src/lib/launchframe-config.ts`, `launchframe.context.json`, and `docs/research/LAUNCHFRAME.md`. **CLI:** **`npx launchframe@latest`** (no args) only **unpacks this template** into an empty directory; then run **`/launchframe <url> "…"`** in that project.
6
-
7
- **Recommended: [Claude Code](https://docs.anthropic.com/en/docs/claude-code) with Opus 4.7 for best results** — but works with a variety of AI coding agents.
8
-
9
- ## Demo
10
-
11
- [![Watch the demo](docs/design-references/comparison.png)](https://youtu.be/O669pVZ_qr0)
12
-
13
- > Click the image above to watch the full demo on YouTube.
14
-
15
- ## Quick Start
16
-
17
- ### 1. New project (empty folder)
18
-
19
- Create an **empty** directory, go into it, run the CLI with **no parameters** — files are written to **that folder** (your project root):
20
-
21
- ```bash
22
- mkdir my-app
23
- cd my-app
24
- npx launchframe@latest
25
- ```
26
-
27
- Optional: set `LAUNCHFRAME_SOURCE_URL` and `LAUNCHFRAME_SAAS_IDEA` in the environment before running to pre-fill config without editing files.
28
-
29
- Then run `npm run dev` and your agent with **`/launchframe <url> "your saas idea"`**.
30
-
31
- ### AI agents
32
-
33
- Use **`/launchframe <url> "saas idea"`** the only clone workflow for this template (URL + SaaS positioning; full extraction/build pipeline).
34
-
35
- To start from zero files in a folder, run **`npx launchframe@latest`** once, then **`/launchframe`** in that project.
36
-
37
- ### Optional flags
38
-
39
- - `--dir path` / `-o path` — scaffold into another folder instead of the current directory (must be empty)
40
- - `--skip-install` — skip `npm install`
41
-
42
- ### Git template (advanced)
43
-
44
- 1. Clone this repository and `npm install`
45
- 2. Point `src/lib/launchframe-config.ts` at your site, or create a sibling folder and run **`npx launchframe@latest`** there
46
- 3. Run **`/launchframe <url> "saas idea"`** from your agent
47
-
48
- > Using a different agent? Open `AGENTS.md` for project instructions — most agents pick it up automatically.
49
-
50
- ## Supported Platforms
51
-
52
- | Agent | Status |
53
- | ------------------------------------------------------------- | -------------------------- |
54
- | [Claude Code](https://docs.anthropic.com/en/docs/claude-code) | **Recommended** — Opus 4.7 |
55
- | [Codex CLI](https://github.com/openai/codex) | Supported |
56
- | [OpenCode](https://opencode.ai/) | Supported |
57
- | [GitHub Copilot](https://github.com/features/copilot) | Supported |
58
- | [Cursor](https://cursor.com/) | Supported |
59
- | [Windsurf](https://codeium.com/windsurf) | Supported |
60
- | [Gemini CLI](https://github.com/google-gemini/gemini-cli) | Supported |
61
- | [Cline](https://github.com/cline/cline) | Supported |
62
- | [Roo Code](https://github.com/RooCodeInc/Roo-Code) | Supported |
63
- | [Continue](https://continue.dev/) | Supported |
64
- | [Amazon Q](https://aws.amazon.com/q/developer/) | Supported |
65
- | [Augment Code](https://www.augmentcode.com/) | Supported |
66
- | [Aider](https://aider.chat/) | Supported |
67
-
68
- ## Prerequisites
69
-
70
- - [Node.js](https://nodejs.org/) 24+
71
- - An AI coding agent (see [Supported Platforms](#supported-platforms))
72
-
73
- ## Tech Stack
74
-
75
- - **Next.js 16** — App Router, React 19, TypeScript strict
76
- - **shadcn/ui** — Radix primitives + Tailwind CSS v4
77
- - **Tailwind CSS v4** — oklch design tokens
78
- - **Lucide React** — default icons (replaced by extracted SVGs during cloning)
79
-
80
- ## How It Works
81
-
82
- The **`/launchframe`** skill runs a multi-phase pipeline:
83
-
84
- 1. **Reconnaissance** — screenshots, design token extraction, interaction sweep (scroll, click, hover, responsive)
85
- 2. **Foundation** — updates fonts, colors, globals, downloads all assets
86
- 3. **Component Specs** — writes detailed spec files (`docs/research/components/`) with exact computed CSS values, states, behaviors, and content
87
- 4. **Parallel Build** — dispatches builder agents in git worktrees, one per section/component
88
- 5. **Assembly & QA** — merges worktrees, wires up the page, runs visual diff against the original
89
-
90
- Each builder agent receives the full component specification inline — exact `getComputedStyle()` values, interaction models, multi-state content, responsive breakpoints, and asset paths. No guessing.
91
-
92
- ## Use Cases
93
-
94
- - **Platform migration** — rebuild a site you own from WordPress/Webflow/Squarespace into a modern Next.js codebase
95
- - **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
96
- - **Learning** — deconstruct how production sites achieve specific layouts, animations, and responsive behavior by working with real code
97
-
98
- ## Not Intended For
99
-
100
- - **Phishing or impersonation** — this project must not be used for deceptive purposes, impersonation, or any activity that breaks the law.
101
- - **Passing off someone's design as your own** — logos, brand assets, and original copy belong to their owners.
102
- - **Violating terms of service** — some sites explicitly prohibit scraping or reproduction. Check first.
103
-
104
- ## Project Structure
105
-
106
- ```
107
- src/
108
- app/ # Next.js routes
109
- components/ # React components
110
- ui/ # shadcn/ui primitives
111
- icons.tsx # Extracted SVG icons
112
- lib/utils.ts # cn() utility
113
- types/ # TypeScript interfaces
114
- hooks/ # Custom React hooks
115
- public/
116
- images/ # Downloaded images from target
117
- videos/ # Downloaded videos from target
118
- seo/ # Favicons, OG images
119
- docs/
120
- research/ # Extraction output & component specs
121
- design-references/ # Screenshots
122
- scripts/
123
- sync-agent-rules.sh # Regenerate agent instruction files
124
- sync-skills.mjs # Regenerate /launchframe for all platforms
125
- AGENTS.md # Agent instructions (single source of truth)
126
- CLAUDE.md # Claude Code config (imports AGENTS.md)
127
- GEMINI.md # Gemini CLI config (imports AGENTS.md)
128
- ```
129
-
130
- ## Commands
131
-
132
- ```bash
133
- npm run dev # Start dev server
134
- npm run build # Production build
135
- npm run lint # ESLint check
136
- npm run typecheck # TypeScript check
137
- npm run check # Run lint + typecheck + build
138
- ```
139
-
140
- ### If using docker
141
-
142
- ```bash
143
- docker compose up app --build # build and run the app
144
- docker compose up dev --build # run the app in dev mode on port 3001
145
- ```
146
-
147
- ## Updating for Other Platforms
148
-
149
- Two source-of-truth files power all platform support. Edit the source, then run the sync script:
150
-
151
- | What | Source of truth | Sync command |
152
- | ---------------------- | --------------------------------------- | ---------------------------------- |
153
- | Project instructions | `AGENTS.md` | `bash scripts/sync-agent-rules.sh` |
154
- | `/launchframe` skill | `.claude/skills/launchframe/SKILL.md` | `node scripts/sync-skills.mjs` |
155
-
156
- Each script regenerates the platform-specific copies automatically. Agents that read the source files natively need no regeneration.
157
-
158
-
159
- ## Star History
160
-
161
- [![Star History Chart](https://api.star-history.com/svg?repos=JCodesMore/ai-website-cloner-template&type=Date)](https://star-history.com/#JCodesMore/ai-website-cloner-template&Date)
162
-
163
- ## License
164
-
165
- MIT
1
+ # Launchframe
2
+
3
+ Next.js + shadcn/ui + Tailwind v4 template for cloning a reference site and layering your SaaS pitch—wired for AI agents. Project rules for agents: **`AGENTS.md`**. In Cursor (and similar), use the **`/launchframe`** command with a URL and your pitch in quotes.
4
+
5
+ Requires **Node.js 24+**.
6
+
7
+ ## Quick start
8
+
9
+ **You already have this repo**
10
+
11
+ ```bash
12
+ npm install
13
+ npm run dev
14
+ ```
15
+
16
+ **New folder**
17
+
18
+ ```bash
19
+ mkdir my-app && cd my-app
20
+ npx launchframe@latest
21
+ ```
22
+
23
+ That unpacks the template and runs `npm install` unless you pass `--skip-install`. Defaults live in **`src/lib/launchframe-config.ts`** (optional: `LAUNCHFRAME_SOURCE_URL` and `LAUNCHFRAME_SAAS_IDEA` in the environment when you scaffold).
24
+
25
+ ## Scripts
26
+
27
+ | Command | What it does |
28
+ | -------- | ------------- |
29
+ | `npm run dev` | Dev server |
30
+ | `npm run build` | Production build |
31
+ | `npm run start` | Run production build |
32
+ | `npm run lint` | ESLint |
33
+ | `npm run typecheck` | TypeScript |
34
+ | `npm run check` | Lint, typecheck, then build |
35
+
36
+ Took inspiration from [JCodesMore/ai-website-cloner-template](https://github.com/JCodesMore/ai-website-cloner-template).
37
+
38
+ MIT