CLAUDE.md
CLAUDE.mdCLAUDE.mdroot
Quality
89/100
Scores the file, not the repository.Length
772 words
20 headings · 1 code blocksRepository
63
— · pushed 15 days agoLast changed
3 days ago
First indexed 3 days ago.1# CLAUDE.md23This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.45## Development Commands67### Core Development8- `npm run dev` - Start development server on port 80809- `npm run build` - Create production build10- `npm run build:dev` - Create development build11- `npm run lint` - Run ESLint linter12- `npm run preview` - Preview production build locally1314### Package Management15- `npm install` - Install dependencies (or use `bun install` for faster installs)1617## Architecture & Structure1819### Framework Stack20- **React 18.3.1** with TypeScript for UI21- **Vite 5.4.1** as build tool with SWC for fast compilation22- **shadcn/ui** component library built on Radix UI primitives23- **Tailwind CSS 3.4.11** for styling with custom design system24- **React Router DOM v6** for client-side routing25- **TanStack Query** for server state management26- **React Hook Form + Zod** for form handling and validation2728### Key Architecture Patterns2930#### Component Organization & Structure31- `src/components/ui/` - Pre-built shadcn/ui components (40+ available, READ-ONLY)32- `src/components/common/` - Reusable components (20-100 lines each)33- `src/components/forms/` - Form-specific components34- `src/components/features/` - Feature-specific components35- `src/pages/` - Route-level page components36- `src/hooks/` - Custom React hooks including `use-mobile.tsx` and `use-toast.ts`37- `src/lib/utils.ts` - Utility functions with Tailwind class merging via `cn()` function38- `src/lib/types.ts` - Shared TypeScript types and interfaces39- `src/lib/constants.ts` - Application constants40- `src/lib/validations/` - Zod validation schemas4142#### Critical Architecture Rules43- **Component Size Limit**: Never exceed 300 lines per component44- **Composition Over Complexity**: Build complex UI from smaller, focused components45- **Single Responsibility**: Each component should have one clear purpose46- **Extract Reusable Logic**: Use custom hooks instead of duplicating code47- **Service Layer Pattern**: No inline API calls in components - use service layer in `src/lib/`4849#### Import Aliases (configured in vite.config.ts)50- `@/` maps to `./src/`51- `@/components` for components52- `@/lib` for utilities53- `@/hooks` for custom hooks5455#### Routing Structure56Routes are defined in `src/App.tsx`. Add new routes above the catch-all `*` route:57```tsx58<Routes>59 <Route path="/" element={<Index />} />60 {/* ADD NEW ROUTES HERE */}61 <Route path="*" element={<NotFound />} />62</Routes>63```6465### Design System Integration6667This project uses a sophisticated design system based on comprehensive instructions in `.github/instructions/` and `.cursor/rules/`. Key principles:6869#### shadcn/ui Components70Over 40 pre-built components available in `src/components/ui/`:71- **Layout**: `card`, `separator`, `sheet`, `sidebar`, `tabs`, `accordion`72- **Forms**: `button`, `input`, `form`, `select`, `checkbox`, `radio-group`73- **Overlays**: `dialog`, `alert-dialog`, `drawer`, `popover`, `tooltip`74- **Data Display**: `table`, `badge`, `avatar`, `chart`, `carousel`7576#### Styling Conventions & Quality Standards77- Use Tailwind classes following the project's design system78- Generous spacing: `py-16 lg:py-24` for sections79- Consistent rhythm: `space-y-4 lg:space-y-6` for content80- Mobile-first responsive design approach81- Premium, sophisticated visual hierarchy with purposeful color psychology82- **Accessibility**: Maintain WCAG 2.1 AA contrast ratios (4.5:1 minimum)83- **Never ship** without running `npm run lint` - must pass without errors84- **Industry-specific designs**: Adapt visual identity, emotional tone, and color psychology to target audience85- **Design Philosophy**: Create unique, custom-crafted interfaces that feel premium and engaging86- **Color Strategy**: Use colors intentionally to evoke the right emotions and enhance user experience8788### Configuration Files8990- `vite.config.ts` - Vite configuration with path aliases and port 808091- `components.json` - shadcn/ui configuration with default style and slate base color92- `tailwind.config.ts` - Tailwind configuration with dark mode support93- `tsconfig.json` - TypeScript configuration with strict mode9495### Environment Variables96⚠️ **Security**: This is a client-side application. Only use `VITE_` prefixed environment variables for public configuration. Never expose sensitive data like API secrets.9798### Testing & Quality99- ESLint configured with React and TypeScript rules100- No test framework currently configured - determine testing approach from codebase if tests are needed101102### Development Patterns & Best Practices103104#### Code Organization105- Use TypeScript interfaces for type safety - define shared types in `src/lib/types.ts`106- Implement responsive design mobile-first107- Follow React Hook Form patterns with Zod validation for forms108- Use TanStack Query for API state management109- Import UI components from `@/components/ui/`110- Use the toast system via `use-toast` hook for notifications111112#### Cursor Rules Integration113This project includes comprehensive Cursor rules in `.cursor/rules/` that auto-apply based on file context:114- **Core Rules** (`core.mdc`) - Always active architecture and quality rules115- **Component Rules** (`components.mdc`) - Auto-loads when editing `src/components/**`116- **Design Rules** (`design.mdc`) - Auto-loads when editing UI/styling files117- **Form Rules** (`forms.mdc`) - Auto-loads when editing form components118- **Hook Rules** (`hooks.mdc`) - Auto-loads when editing `src/hooks/**`119- **Service Rules** (`services.mdc`) - Auto-loads when editing `src/lib/**`120121Reference with `@rule-name` in prompts (e.g., `@quality` for quality checklist)
Also in chihebnabil/lovable-boilerplate
Diff this repo’s formatsOne repository carrying more than one format is the comparison this product exists for: does anyone actually write different content in each file, or is one a copy of the other?
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| chihebnabil/lovable-boilerplate.cursor/rules/design.mdc · 63 | Cursor rules | styleuido-not | 65/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/forms.mdc · 63 | Cursor rules | setupstyledo-not | 73/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/hooks.mdc · 63 | Cursor rules | styleuido-not | 61/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/services.mdc · 63 | Cursor rules | archtypesdo-not | 73/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/typescript.mdc · 63 | Cursor rules | setupstyletypessecurity+2 | 73/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/architecture.instructions.md · 63 | Copilot instructions | stylearchtypesdatabase+2 | 69/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/design.instructions.md · 63 | Copilot instructions | lint-formatstyleuido-not | 61/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/development.instructions.md · 63 | Copilot instructions | setupbuildtestlint-format+7 | 88/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/hooks.instructions.md · 63 | Copilot instructions | styleui | 54/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/lib.instructions.md · 63 | Copilot instructions | archtypesdo-not | 69/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/pages.instructions.md · 63 | Copilot instructions | archuido-not | 69/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/quality.instructions.md · 63 | Copilot instructions | lint-formatdeploymentdo-not | 63/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/reusable.instructions.md · 63 | Copilot instructions | uido-notagent-behaviour | 32/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/core.mdc · 63 | Cursor rules | buildlint-formatarchui+1 | 92/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/components.instructions.md · 63 | Copilot instructions | styleuido-not | 61/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.github/instructions/global.instructions.md · 63 | Copilot instructions | buildlint-formatstylearch+4 | 100/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/components.mdc · 63 | Cursor rules | stylearchuido-not | 65/100 | 3 days ago | |
| chihebnabil/lovable-boilerplate.cursor/rules/quality.mdc · 63 | Cursor rules | buildlint-formatstyleui+3 | 88/100 | 3 days ago |
Diff against .cursor/rules/design.mdc Diff against .cursor/rules/forms.mdc Diff against .cursor/rules/hooks.mdc Diff against .cursor/rules/services.mdc Diff against .cursor/rules/typescript.mdc Diff against .github/instructions/architecture.instructions.md Diff against .github/instructions/design.instructions.md Diff against .github/instructions/development.instructions.md Diff against .github/instructions/hooks.instructions.md Diff against .github/instructions/lib.instructions.md Diff against .github/instructions/pages.instructions.md Diff against .github/instructions/quality.instructions.md Diff against .github/instructions/reusable.instructions.md Diff against .cursor/rules/core.mdc Diff against .github/instructions/components.instructions.md Diff against .github/instructions/global.instructions.md Diff against .cursor/rules/components.mdc Diff against .cursor/rules/quality.mdc
Similar configs
Same format, overlapping stack, ranked by quality.
| Repository | Format | Stack | Covers | Score | Changed |
|---|---|---|---|---|---|
| Adit-Jain-srm/NightmareNetCLAUDE.md · 45 | CLAUDE.md | buildtestlint-formatstyle+6 | 100/100 | 3 days ago | |
| nimbalyst/nimbalystpackages/android/CLAUDE.md · 1.4k | CLAUDE.md | setupbuildstylearch+2 | 100/100 | 3 days ago | |
| microsoft/playwrightCLAUDE.md · 94k | CLAUDE.md | buildtestlint-formatstyle+7 | 100/100 | 3 days ago | |
| dotCMS/corecore-web/CLAUDE.md · 949 | CLAUDE.md | teststylearchtesting-strategy+3 | 100/100 | 3 days ago | |
| dotCMS/coreCLAUDE.md · 949 | CLAUDE.md | setupbuildteststyle+7 | 99/100 | today | |
| lollipopkit/flutter_server_boxCLAUDE.md · 8.3k | CLAUDE.md | buildteststylearch+2 | 98/100 | 3 days ago | |
| modelcontextprotocol/serversCLAUDE.md · 89k | CLAUDE.md | setupbuildtestlint-format+6 | 97/100 | 3 days ago | |
| caliber-ai-org/ai-setupCLAUDE.md · 1.2k | CLAUDE.md | buildtestlint-formatstyle+1 | 97/100 | 3 days ago |
