wehub-resource-sync
108 lines
4.6 KiB
Markdown
108 lines
4.6 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Project Overview
|
|
|
|
UI UX Pro Max is an AI-powered design intelligence toolkit providing searchable databases of UI styles, color palettes, font pairings, chart types, and UX guidelines. It works as a skill/workflow for AI coding assistants (Claude Code, Windsurf, Cursor, etc.).
|
|
|
|
## Search Command
|
|
|
|
```bash
|
|
python3 src/ui-ux-pro-max/scripts/search.py "<query>" --domain <domain> [-n <max_results>]
|
|
```
|
|
|
|
**Domain search:**
|
|
- `product` - Product type recommendations (SaaS, e-commerce, portfolio)
|
|
- `style` - UI styles (glassmorphism, minimalism, brutalism) + AI prompts and CSS keywords
|
|
- `typography` - Font pairings with Google Fonts imports
|
|
- `color` - Color palettes by product type
|
|
- `landing` - Page structure and CTA strategies
|
|
- `chart` - Chart types and library recommendations
|
|
- `ux` - Best practices and anti-patterns
|
|
- `gsap` - GSAP animation skeletons by intensity tier (hover, scroll reveal, stagger, page transition, parallax, loading)
|
|
|
|
**Design dials (optional, only with `--design-system`):**
|
|
```bash
|
|
python3 src/ui-ux-pro-max/scripts/search.py "<query>" --design-system --variance <1-10> --motion <1-10> --density <1-10>
|
|
```
|
|
`--variance` biases style selection (centered/minimal → bold/asymmetric), `--motion` attaches a matching GSAP snippet from `motion.csv`, `--density` overrides the spacing-scale tokens (spacious → dense/dashboard). Any dial left unset behaves exactly as before.
|
|
|
|
**Stack search:**
|
|
```bash
|
|
python3 src/ui-ux-pro-max/scripts/search.py "<query>" --stack <stack>
|
|
```
|
|
Available stacks: `html-tailwind` (default), `react`, `nextjs`, `astro`, `vue`, `nuxtjs`, `nuxt-ui`, `svelte`, `swiftui`, `react-native`, `flutter`, `shadcn`, `jetpack-compose`, `threejs`, `angular`, `laravel`, `javafx`, `wpf`, `winui`, `avalonia`, `uno`, `uwp`
|
|
|
|
## Architecture
|
|
|
|
```
|
|
src/ui-ux-pro-max/ # Source of Truth
|
|
├── data/ # Canonical CSV databases
|
|
│ ├── products.csv, styles.csv, colors.csv, typography.csv, ...
|
|
│ └── stacks/ # Stack-specific guidelines
|
|
├── scripts/
|
|
│ ├── search.py # CLI entry point
|
|
│ ├── core.py # BM25 + regex hybrid search engine
|
|
│ └── design_system.py # Design system generation
|
|
└── templates/
|
|
├── base/ # Base templates (skill-content.md, quick-reference.md)
|
|
└── platforms/ # Platform configs (claude.json, cursor.json, ...)
|
|
|
|
cli/ # CLI installer (ui-ux-pro-max-cli on npm)
|
|
├── src/
|
|
│ ├── commands/init.ts # Install command with template generation
|
|
│ └── utils/template.ts # Template rendering engine
|
|
└── assets/ # Bundled assets (~564KB)
|
|
├── data/ # Copy of src/ui-ux-pro-max/data/
|
|
├── scripts/ # Copy of src/ui-ux-pro-max/scripts/
|
|
└── templates/ # Copy of src/ui-ux-pro-max/templates/
|
|
|
|
.claude/skills/ui-ux-pro-max/ # Claude Code skill (symlinks to src/)
|
|
.factory/skills/ui-ux-pro-max/ # Droid (Factory) skill (symlinks to src/)
|
|
.shared/ui-ux-pro-max/ # Symlink to src/ui-ux-pro-max/
|
|
.claude-plugin/ # Claude Marketplace publishing
|
|
```
|
|
|
|
The search engine uses BM25 ranking combined with regex matching. Domain auto-detection is available when `--domain` is omitted.
|
|
|
|
## Sync Rules
|
|
|
|
**Source of Truth:** `src/ui-ux-pro-max/`
|
|
|
|
When modifying files:
|
|
|
|
1. **Data & Scripts** - Edit in `src/ui-ux-pro-max/`:
|
|
- `data/*.csv` and `data/stacks/*.csv`
|
|
- `scripts/*.py`
|
|
- Changes automatically available via symlinks in `.claude/`, `.factory/`, `.shared/`
|
|
|
|
2. **Templates** - Edit in `src/ui-ux-pro-max/templates/`:
|
|
- `base/skill-content.md` - Common SKILL.md content
|
|
- `base/quick-reference.md` - Quick reference section (Claude only)
|
|
- `platforms/*.json` - Platform-specific configs
|
|
|
|
3. **CLI Assets** - Run sync before publishing:
|
|
```bash
|
|
cd cli
|
|
npm run sync:assets
|
|
npm run check:assets
|
|
```
|
|
|
|
4. **Reference Folders** - No manual sync needed. The CLI generates these from templates during `uipro init`.
|
|
|
|
## Prerequisites
|
|
|
|
Python 3.x (no external dependencies required)
|
|
|
|
**Note:** On Windows, use `python` instead of `python3` to run the scripts.
|
|
|
|
## Git Workflow
|
|
|
|
Never push directly to `main`. Always:
|
|
|
|
1. Create a new branch: `git checkout -b feat/...` or `fix/...`
|
|
2. Commit changes
|
|
3. Push branch: `git push -u origin <branch>`
|
|
4. Create PR: `gh pr create`
|