Claude Code Project Instructions (CLAUDE.md)

AI-generated CLAUDE.md example with project context, commands and verification steps. Replace the sample stack and commands with your repository details.

Tags: claude-code, instructions, conventions, architecture, guardrails

Category: coding

Listing attribution: SimplyUtils

Before using this resource

Attribution and license labels come from the listing metadata. Check the source and its license before redistributing or adapting files. This listing has no documented license; do not assume permission to redistribute it.

Read instructions before adding them to an agent or project. Test a small, non-confidential example and inspect the result. A downloaded instruction file may refer to scripts, templates, or other files that are not included here.

SimplyUtils supplied this template, which was generated by an AI agent using an LLM. It is an example to inspect and adapt, not a verified package or a record of expert testing. Check named dependencies, commands, permissions and generated results before use. Redistribution terms for this template have not been verified; licenses for third-party software are separate.

Claude Code Project Instructions (CLAUDE.md)

This file provides persistent instructions and architectural context for Claude Code when working in this repository.

1. Project Overview & Architecture

  • Framework & Runtime: Node.js 20+, React 18 / Next.js 14, TypeScript (Strict Mode).
  • Styling: Tailwind CSS + shadcn/ui components. Avoid inline styles or custom ad-hoc CSS classes.
  • Backend & Database: Express / Hono API with Drizzle ORM and PostgreSQL.
  • State & Routing: Wouter / Next.js App Router with TanStack Query for server state.

2. Core Development Rules

1. TypeScript Strictness: Never use any. Use unknown and narrow via type guards or Zod schemas.

2. Component Conventions:

  • Keep components focused and under 250 lines.
  • Separate business logic into custom hooks in src/hooks/.
  • Use Lucide React icons for all UI iconography.

3. Database Operations:

  • Never write raw SQL in route handlers; use the storage layer in server/storage.ts.
  • Always wrap multi-table modifications in transactions.

4. Error Handling:

  • Always return standardized JSON error objects: { error: string, code?: string, details?: any }.
  • Never leak stack traces or internal environment variables to client responses.

3. Essential Commands

# Development server
npm run dev

# Type check & linting
npm run check
npm run lint

# Database migrations
npm run db:push

# Test suites
npm run test
npm run test:e2e

4. Verification Protocol Before Completing Tasks

  • [ ] Run npm run check and verify 0 TypeScript diagnostic errors.
  • [ ] Ensure all modified functions have corresponding unit tests in tests/.
  • [ ] Verify that no console.log or debug comments remain in source files.
  • [ ] Check responsive layout on both desktop and 390px mobile viewport widths.