south-admin-react CLAUDE.md

CLAUDE.md

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

Commands

Development

pnpm dev              # Start dev server (Vite with host flag)
pnpm build            # Production build (TypeScript + Vite)
pnpm build:dev        # Development build
pnpm build:test       # Test environment build

Code Quality

pnpm lint             # ESLint with auto-fix
pnpm lint:stylelint   # Stylelint for CSS/Less
pnpm prettier         # Format code with Prettier

Package Management

pnpm install -w       # Install dependencies (use -w for monorepo root)
pnpm i <package> -w   # Install new dependencies at workspace root

Git

npx husky install     # Reinstall husky hooks if commit fails

Project Architecture

This is a monorepo-based React admin application using pnpm workspaces, built with Vite, TypeScript, React 19, Ant Design, and Zustand.

Monorepo Structure

• Root: Main application in src/
• packages/: Shared workspace packages
  • @south/request: HTTP request wrapper
  • @south/message: Global messaging component
  • @south/utils: Shared utilities
  • @south/stylelint: Stylelint configuration

When installing new dependencies, use pnpm i <package> -w to install at the workspace root.

Automatic Route Generation

Routes are automatically generated from the src/pages/ directory structure using vite glob:

// src/router/utils/config.ts
export const ROUTER_EXCLUDE = [
  'login', 'forget', 'components', 'utils', 'lib', 'hooks',
  'model.tsx', '404.tsx'
];

Route rules:

• File path src/pages/dashboard/index.tsx → route /dashboard
• File path src/pages/dashboard/index.tsx → route /
• Dynamic routes use [param] syntax: src/pages/user/[id].tsx → route /user/:id
• All index.tsx files have /index removed from the route path

Route configuration is in src/router/components/Router.tsx using handleRoutes() helper.