Skip to content

CLAUDE.md

Latest commit

 

History

History
41 lines (33 loc) · 2.88 KB

CLAUDE.md

File metadata and controls

41 lines (33 loc) · 2.88 KB
Raw

CLAUDE.md

Commands

  • npm run dev - Start dev server
  • npm run typecheck - Type checking

Structure

  • /common - Shared Redux/API (no web/mobile code)
  • /web/components - React components (includes /web/components/pages/ for all page components)
  • /web/components/pages/ - All page components (e.g., FeaturesPage.js, ProjectSettingsPage.js)
  • /common/types/ - requests.ts and responses.ts for API types
  • Ignore: ios/, android/, .net/, *.md.draft

Rules

  1. API Integration: Use npx ssg CLI + check ../api backend
  2. Imports: Use common/, components/, project/ (NO relative imports)
  3. State: Redux Toolkit + RTK Query, store in common/store.ts
  4. Feature Flags: When user says "create a feature flag", you MUST: (1) Create it in Flagsmith using MCP tools (mcp__flagsmith__create_feature), (2) Implement code with useFlags hook. See .claude/context/feature-flags/ for details
  5. Linting: ALWAYS run npx eslint --fix <file> on any files you modify
  6. Type Enums: Extract inline union types to named types (e.g., type Status = 'A' | 'B' instead of inline)
  7. NO FETCH: NEVER use fetch() directly - ALWAYS use RTK Query mutations/queries (inject endpoints into services in common/services/), see api-integration context
  8. Component structure: Each new component lives in its own folder with an index.ts barrel - ComponentName/ComponentName.tsx, co-located ComponentName.scss, any sub-components, and an index.ts that re-exports the default (and public types). Import via the folder (components/.../ComponentName), never the inner file. Keep files focused (~100 lines as a target); split by concern, not to hit a number. Data tables/constant maps are exempt.

Key Files

  • Store: common/store.ts
  • Base service: common/service.ts

Context Files

The .claude/context/ directory contains required patterns and standards for this codebase. These are not optional suggestions - they document how things must be done in this project.

For detailed guidance on specific topics:

  • Quick Start: .claude/context/quick-reference.md - Common tasks, commands, patterns
  • API Integration: .claude/context/api-integration.md - Adding endpoints, RTK Query (required reading for API work)
  • Backend: .claude/context/backend-integration.md - Finding endpoints, backend structure
  • Testing vs PR backend: .claude/context/testing-against-pr-backend.md - Run an unmerged backend PR's Docker image locally and point the dev server at it
  • UI Patterns: .claude/context/ui-patterns.md - Tables, tabs, modals, confirmations (required reading for UI work)
  • Feature Flags: .claude/context/feature-flags/ - Using Flagsmith flags (optional, only when requested)
  • Code Patterns: .claude/context/patterns/ - Complete examples, best practices

Tip: Start with quick-reference.md for common tasks and checklists.