Skip to content

CLAUDE.md

Latest commit

 

History

History
95 lines (69 loc) · 3.42 KB

CLAUDE.md

File metadata and controls

95 lines (69 loc) · 3.42 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Structure

This is a Turborepo monorepo with the following structure:

  • apps/api - NestJS backend application (runs on port 3000)
  • apps/web - Vite + React frontend application (runs on port 5173)
  • packages/@caseai-connect/api-contracts - Shared API contracts and DTOs
  • packages/@repo/jest-config - Shared Jest configurations
  • packages/@repo/typescript-config - Shared TypeScript configurations
  • packages/@caseai-connect/ui - Shared React component library

Development Commands

All commands should be run from the root directory using Turbo (via npm scripts):

Development

  • npx turbo dev - Start all applications in development mode
  • npx turbo dev --filter=api - Start only the API application
  • npx turbo dev --filter=web - Start only the web application

Building

  • npx turbo build - Build all applications and packages
  • npx turbo build --filter=api - Build only the API application
  • npx turbo build --filter=web - Build only the web application

Testing

  • npx turbo test - Run all tests
  • npx turbo test --filter=api - Run API tests only
  • npx turbo test --filter=web - Run web tests only

Code Quality

  • npx turbo lint - Lint all packages and applications

TypeScript Compilation Check

  • cd apps/api && npx tsc --noEmit - Check API TypeScript without emitting files
  • cd apps/web && npx tsc --noEmit - Check web TypeScript without emitting files

Architecture Notes

API Application

  • Built with NestJS framework
  • Entry point: apps/api/src/main.ts
  • Main module: apps/api/src/app.module.ts
  • Modular structure with feature-based modules under apps/api/src/domains/
  • Uses dependency injection and decorators pattern
  • See apps/api/CLAUDE.md for detailed API rules

Web Application

  • Vite + React (SPA) with React Compiler enabled via babel-plugin-react-compiler
  • Redux for state management with feature-based slices/thunks/selectors
  • Integrates with shared UI component library from @caseai-connect/ui
  • Entry point: apps/web/src/main.tsx
  • See apps/web/CLAUDE.md for detailed web rules

Shared Packages

  • api-contracts: DTOs and route definitions shared between API and web
    • All DTOs consolidated per domain: packages/api-contracts/src/{domain}/{domain}.dto.ts
    • All routes defined with defineRoute in *.routes.ts files
    • Everything exported from packages/api-contracts/src/index.ts
  • All packages use TypeScript with strict configuration
  • Jest configuration centralized in @repo/jest-config

Package Management

  • Uses npm workspaces for monorepo management
  • Private packages with internal dependencies using * version specifier
  • Engines requirement: Node.js >= 18

Code Style

Descriptive Variable Names in Loops

Rule: NEVER use single-letter variables in loops (for, map, forEach, etc.). Always use descriptive, human-readable variable names based on the type of object being iterated.

// ❌ Wrong
projects.map((p) => p.name)

// ✅ Correct
projects.map((project) => project.name)

Completion Criteria

Before marking any work as completed, run and verify:

  1. npm run biome:check — formatting and linting must pass
  2. npm run typecheck — no TypeScript errors
  3. npm run test — all tests must pass (API work)

Work is NOT complete until all applicable commands pass with exit code 0.