Skip to main content
skill CX Codex

webflow-code-component:local-dev-setup — Claude Code skill for Webflow Code Components

webflow-code-component:local-dev-setup is a skill that scaffolds a fresh Webflow Code Components project with folders, dependencies, webflow.json, and a starter component.

MIT 1,000 installs ★ 137 updated 2026-10-22

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add webflow/webflow-skills --skill webflow-code-component:local-dev-setup -a claude-code
Open on GitHub

What webflow-code-component:local-dev-setup does

The skill walks through five phases. First it checks what already exists: package.json, webflow.json, the current folder layout. Then it decides whether this is a brand-new project or Code Components are being added to an existing React codebase. Next.js and Vite projects are covered too.

After that it creates the structure, installs packages, and writes the configs. webflow.json gets the library name and a glob pattern for components; tsconfig.json has JSX enabled. A sample Button component comes last, plus an optional globals file for shared styles and decorators.

Local verification runs npx webflow library bundle --public-path http://localhost:4000/. Full testing inside the Webflow Designer still needs npx webflow library share — the local build catches errors but does not replace a deploy. Requires Node.js 18+, React 18+, TypeScript, and @webflow/webflow-cli.

What it helps with

  • scaffold a new Code Components project from an empty folder
  • add Webflow Code Components to an existing React or Next.js app
  • write webflow.json with a component glob pattern
  • run a local bundle build to catch config errors before deploying
  • generate a Button component with definition file and CSS module

Example prompts for the agent

  • Set up a new Webflow Code Components project in this directory
  • Add Code Components to my current React project
  • Configure the Webflow dev environment and verify the bundle builds locally

How to install webflow-code-component:local-dev-setup

1Skills CLI (Vercel)

npx skills add webflow/webflow-skills --skill webflow-code-component:local-dev-setup -a claude-code

2Manually: put the files in place

~/.claude/skills/local-dev-setup/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/local-dev-setup/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about webflow-code-component:local-dev-setup

How do I install webflow-code-component:local-dev-setup in Claude Code?

Run npx skills add webflow/webflow-skills --skill webflow-code-component:local-dev-setup -a claude-code. The skill lands at ~/.claude/skills/local-dev-setup/SKILL.md.

What does this skill do?

It initializes a Webflow Code Components project: folder structure, React and TypeScript dependencies, webflow.json with a glob pattern, tsconfig.json with JSX, and a starter Button component.

What do I need before using it?

Node.js 18+, React 18+, TypeScript, and the packages @webflow/webflow-cli, @webflow/data-types, @webflow/react. The local bundle check will not run without @webflow/webflow-cli.

Source text

SKILL.md · MIT
---
name: webflow-code-component:local-dev-setup
description: Initialize a new Webflow Code Components project from scratch. Creates project structure, installs dependencies, configures webflow.json, and sets up development environment.
compatibility: Node.js 18+, React 18+, TypeScript, @webflow/webflow-cli
metadata:
  author: webflow
  version: "1.1"
---

# Local Dev Setup

Set up a new Webflow Code Components project from scratch.

## When to Use This Skill

**Use when:**
- Starting a brand new code components project
- User asks to set up, initialize, or create a new project
- Adding code components to an existing React project
- Setting up the development environment for the first time

**Do NOT use when:**
- Project already exists and is configured (just answer questions directly)
- Creating individual components (use component-scaffold instead)
- Deploying components (use deploy-guide instead)

## Instructions

### Phase 1: Assess Current State

1. **Check if project exists**:
   - Is there an existing package.json?
   - Is there an existing webflow.json?
   - What's the current project structure?

2. **Determine setup type**:
   - New project from scratch
   - Add to existing React project
   - Add to existing Next.js/Vite project

### Phase 2: Project Initialization

3. **Create project structure** (if new):
   - Initialize npm project
   - Set up TypeScript
   - Create folder structure

4. **Install dependencies**:
   - Core: React, TypeScript
   - Webflow: CLI, data-types, react utils
   - Optional: Styling libraries

### Phase 3: Configuration

5. **Create webflow.json**:
   - Set library name
   - Configure component glob pattern
   - Set up globals if needed

6. **Configure TypeScript**:
   - Set up tsconfig.json
   - Enable JSX support

### Phase 4: Create Starter Files

7. **Create example component**:
   - Simple Button component
   - Definition file
   - Basic styling

8. **Create globals file** (optional):
   - For shared styles
   - For decorators

### Phase 5: Verify Setup

9. **Verify bundle compiles**:
   - Run `npx webflow library bundle --public-path http://localhost:4000/` to catch build errors locally
   - This verifies your components, imports, and configuration are correct
   - Full testing in the Webflow Designer requires deploying with `npx webflow library share`

10. **Provide next steps**:
    - How to create more components
    - How to deploy
    - Development workflow

## Examples

For detailed step-by-step examples, see [references/EXAMPLES.md](references/EXAMPLES.md).

**Available examples:**
1. **New Project from Scratch** - Complete setup with React, TypeScript, and CSS Modules
2. **Add to Existing React Project** - Integrate code components into an existing codebase
3. **With Tailwind CSS** - Setup with Tailwind CSS support

**Quick Start (New Project):**

```bash
# 1. Create project
mkdir my-webflow-components && cd my-webflow-components
npm init -y

# 2. Install dependencies
npm install react react-dom
npm install -D typescript @types/react @types/react-dom
npm install -D @webflow/webflow-cli @webflow/data-types @webflow/react

# 3. Create webflow.json
echo '{"library":{"name":"My Library","components":["./src/**/*.webflow.tsx"]}}' > webflow.json

# 4. Create component directory
mkdir -p src/components/Button
```

Then create your component files (.tsx, .webflow.tsx, .module.css). See Example 1 in [references/EXAMPLES.md](references/EXAMPLES.md) for complete file contents including component, definition, and CSS files.

Deploy with:
```bash
npx webflow library share
```

## Validation

After setup, verify the project is correctly configured:

| Check | How to Verify |
|-------|---------------|
| `webflow.json` exists in project root | `cat webflow.json` |
| Dependencies installed | `npm list @webflow/webflow-cli` |
| Bundle compiles without errors | `npx webflow library bundle --public-path http://localhost:4000/` |
| At least one component found | Check bundle output for "Found N component(s)" |

## Guidelines

### Minimum Requirements

Every code components project needs:

1. **package.json** with dependencies
2. **webflow.json** with library config
3. **tsconfig.json** (for TypeScript)
4. At least one `.webflow.tsx` file

### Recommended Structure

```
project/
├── src/
│   ├── components/
│   │   └── [ComponentName]/
│   │       ├── [ComponentName].tsx
│   │       ├── [ComponentName].webflow.tsx
│   │       └── [ComponentName].module.css
│   ├── hooks/           # Custom hooks
│   ├── utils/           # Utilities
│   ├── declarations.d.ts # CSS module types
│   ├── globals.ts       # Decorators/global imports
│   └── globals.css      # Global styles
├── package.json
├── tsconfig.json
├── webflow.json
└── .gitignore
```

### Development Workflow

1. **Create component**: Use [component-scaffold](../component-scaffold/SKILL.md) skill
2. **Develop locally**: Run React project to iterate (e.g., `npm run dev`)
3. **Validate**: Use [pre-deploy-check](../pre-deploy-check/SKILL.md) skill
4. **Deploy**: Use [deploy-guide](../deploy-guide/SKILL.md) skill or run `npx webflow library share`
5. **Test in Webflow**: Add component to page in Designer

© webflow · MIT · webflow/webflow-skills

Similar skills

All skills for Frontend and UI →

From the same set32

The whole set →
webflow-cli:troubleshooter webflow-cli:troubleshooter is a Claude Code skill that diagnoses Webflow CLI failures and applies fixes based on a failed command's output. CX Codex +1 1,100installs webflow-code-component:troubleshoot-deploy webflow-code-component:troubleshoot-deploy is a Claude Code skill that diagnoses Webflow Code Components deploy failures. Run it after webflow library share crashes or a published component misbehaves. CX Codex +1 1,000installs webflow-code-component:deploy-guide webflow-code-component:deploy-guide is a Claude Code skill that guides publishing a code component library to a Webflow workspace, from pre-flight checks to verification in Designer. CX Codex +1 1,000installs webflow-code-component:pre-deploy-check webflow-code-component:pre-deploy-check is a Claude Code skill that validates Webflow Code Components before publishing, checking bundle size, dependencies, props, SSR and styling. CX Codex +1 1,000installs webflow-code-component:convert-component webflow-code-component:convert-component is a Claude Code skill that turns an existing React component into a Webflow Code Component, reads its props and flags what has to change. CX Codex +1 1,000installs webflow-cli:devlink The webflow-cli:devlink skill for Claude Code exports Webflow Designer components to React and Next.js, syncs design edits, and shows what changed after each sync. CX Codex +1 1,000installs webflow-code-component:component-scaffold webflow-code-component:component-scaffold is a Claude Code skill that scaffolds Webflow Code Components with a React 18+ file and .webflow.tsx definition. It checks project dependencies before generating code. CX Codex +1 1,000installs webflow-mcp:accessibility-audit webflow-mcp:accessibility-audit is a Claude Code skill that audits Webflow pages against WCAG 2.1 and fixes interactive-element issues without opening Designer. CX Codex +1 943installs

Project sponsors

Companies that keep this analytics open