项目指南技能（示例）
这是项目特定技能的示例。请将其作为自己项目的模板使用。
基于实际生产应用：Zenith - AI驱动的客户发现平台。
使用时机
在为此技能设计的特定项目工作时参考。项目技能包括：
- 架构概述
- 文件结构
- 代码模式
- 测试要求
- 部署工作流
架构概述
技术栈：
- 前端: Next.js 15 (App Router), TypeScript, React
- 后端: FastAPI (Python), Pydantic模型
- 数据库: Supabase (PostgreSQL)
- AI: Claude工具调用和结构化输出API
- 部署: Google Cloud Run
- 测试: Playwright (E2E), pytest (后端), React Testing Library
服务：
┌─────────────────────────────────────────────────────────────┐
│ 前端 │
│ Next.js 15 + TypeScript + TailwindCSS │
│ 部署: Vercel / Cloud Run │
└─────────────────────────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────────────────────────┐
│ 后端 │
│ FastAPI + Python 3.11 + Pydantic │
│ 部署: Cloud Run │
└─────────────────────────────────────────────────────────────┘
│
┌───────────────┼───────────────┐
▼ ▼ ▼
┌──────────┐ ┌──────────┐ ┌──────────┐
│ Supabase │ │ Claude │ │ Redis │
│ 数据库 │ │ API │ │ 缓存 │
└──────────┘ └──────────┘ └──────────┘
文件结构
project/
├── frontend/
│ └── src/
│ ├── app/ # Next.js app router页面
│ │ ├── api/ # API路由
│ │ ├── (auth)/ # 认证保护路由
│ │ └── workspace/ # 主应用工作空间
│ ├── components/ # React组件
│ │ ├── ui/ # 基础UI组件
│ │ ├── forms/ # 表单组件
│ │ └── layouts/ # 布局组件
│ ├── hooks/ # 自定义React钩子
│ ├── lib/ # 工具库
│ ├── types/ # TypeScript定义
│ └── config/ # 配置
│
├── backend/
│ ├── routers/ # FastAPI路由处理器
│ ├── models.py # Pydantic模型
│ ├── main.py # FastAPI应用入口
│ ├── auth_system.py # 认证系统
│ ├── database.py # 数据库操作
│ ├── services/ # 业务逻辑
│ └── tests/ # pytest测试
│
├── deploy/ # 部署配置
├── docs/ # 文档
└── scripts/ # 工具脚本
代码模式
API响应格式 (FastAPI)
from pydantic import BaseModel
from typing import Generic, TypeVar, Optional
T = TypeVar('T')
class ApiResponse(BaseModel, Generic[T]):
success: bool
data: Optional[T] = None
error: Optional[str] = None
@classmethod
def ok(cls, data: T) -> "ApiResponse[T]":
return cls(success=True, data=data)
@classmethod
def fail(cls, error: str) -> "ApiResponse[T]":
return cls(success=False, error=error)
前端API调用 (TypeScript)
interface ApiResponse<T> {
success: boolean
data?: T
error?: string
}
async function fetchApi<T>(
endpoint: string,
options?: RequestInit
): Promise<ApiResponse<T>> {
try {
const response = await fetch(`/api${endpoint}`, {
...options,
headers: {
'Content-Type': 'application/json',
...options?.headers,
},
})
if (!response.ok) {
return { success: false, error: `HTTP ${response.status}` }
}
return await response.json()
} catch (error) {
return { success: false, error: String(error) }
}
}
Claude AI集成（结构化输出）
from anthropic import Anthropic
from pydantic import BaseModel
class AnalysisResult(BaseModel):
summary: str
key_points: list[str]
confidence: float
async def analyze_with_claude(content: str) -> AnalysisResult:
client = Anthropic()
response = client.messages.create(
model="claude-sonnet-4-5-20250514",
max_tokens=1024,
messages=[{"role": "user", "content": content}],
tools=[{
"name": "provide_analysis",
"description": "Provide structured analysis",
"input_schema": AnalysisResult.model_json_schema()
}],
tool_choice={"type": "tool", "name": "provide_analysis"}
)
# 提取工具使用结果
tool_use = next(
block for block in response.content
if block.type == "tool_use"
)
return AnalysisResult(**tool_use.input)
自定义钩子 (React)
import { useState, useCallback } from 'react'
interface UseApiState<T> {
data: T | null
loading: boolean
error: string | null
}
export function useApi<T>(
fetchFn: () => Promise<ApiResponse<T>>
) {
const [state, setState] = useState<UseApiState<T>>({
data: null,
loading: false,
error: null,
})
const execute = useCallback(async () => {
setState(prev => ({ ...prev, loading: true, error: null }))
const result = await fetchFn()
if (result.success) {
setState({ data: result.data!, loading: false, error: null })
} else {
setState({ data: null, loading: false, error: result.error! })
}
}, [fetchFn])
return { ...state, execute }
}
测试要求
后端 (pytest)
# 运行所有测试
poetry run pytest tests/
# 带覆盖率运行
poetry run pytest tests/ --cov=. --cov-report=html
# 运行特定测试文件
poetry run pytest tests/test_auth.py -v
测试结构：
import pytest
from httpx import AsyncClient
from main import app
@pytest.fixture
async def client():
async with AsyncClient(app=app, base_url="http://test") as ac:
yield ac
@pytest.mark.asyncio
async def test_health_check(client: AsyncClient):
response = await client.get("/health")
assert response.status_code == 200
assert response.json()["status"] == "healthy"
前端 (React Testing Library)
# 运行测试
npm run test
# 带覆盖率运行
npm run test -- --coverage
# 运行E2E测试
npm run test:e2e
测试结构：
import { render, screen, fireEvent } from '@testing-library/react'
import { WorkspacePanel } from './WorkspacePanel'
describe('WorkspacePanel', () => {
it('renders workspace correctly', () => {
render(<WorkspacePanel />)
expect(screen.getByRole('main')).toBeInTheDocument()
})
it('handles session creation', async () => {
render(<WorkspacePanel />)
fireEvent.click(screen.getByText('New Session'))
expect(await screen.findByText('Session created')).toBeInTheDocument()
})
})
部署工作流
部署前检查清单
- [ ] 所有测试在本地成功
- [ ]
npm run build成功（前端） - [ ]
poetry run pytest成功（后端） - [ ] 没有硬编码的密钥
- [ ] 环境变量已文档化
- [ ] 数据库迁移已准备
部署命令
# 前端构建和部署
cd frontend && npm run build
gcloud run deploy frontend --source .
# 后端构建和部署
cd backend
gcloud run deploy backend --source .
环境变量
# 前端 (.env.local)
NEXT_PUBLIC_API_URL=https://api.example.com
NEXT_PUBLIC_SUPABASE_URL=https://xxx.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=eyJ...
# 后端 (.env)
DATABASE_URL=postgresql://...
ANTHROPIC_API_KEY=sk-ant-...
SUPABASE_URL=https://xxx.supabase.co
SUPABASE_KEY=eyJ...
重要规则
- 无表情符号 - 代码、注释、文档中不使用表情符号
- 不可变性 - 不修改对象或数组
- TDD - 实现前先写测试
- 80%覆盖率 - 最低标准
- 小文件多数量 - 通常200-400行，最多800行
- 禁止console.log - 生产代码中不使用
- 适当的错误处理 - 使用try/catch
- 输入验证 - 使用Pydantic/Zod
相关技能
coding-standards.md- 通用编码最佳实践backend-patterns.md- API和数据库模式frontend-patterns.md- React和Next.js模式tdd-workflow/- 测试驱动开发方法论