快速开始

本指南帮助开发者和评审在本地环境中快速安装依赖、启动服务并执行基础验证。

环境要求

• Node.js：>= 20
• pnpm：>= 9
• Go：>= 1.24（API 服务与后端验证）
• Task：用于执行根目录统一开发指令（Taskfile.yml）
• Docker：用于运行本地隔离的 Kratos 认证与数据库依赖（可选，用于真实认证测试）

快速安装与检查

在项目根目录下，先执行依赖安装与开发环境自检：

# 安装锁定依赖与本地开发钩子
task setup

# 检查开发环境基础工具链
task doctor

本地启动

TJUClaw 提供了不同模块的独立启动命令：

1. 运行文档站

# 启动 Fumadocs 文档站（端口 3030）
task docs:dev

启动后可在浏览器访问文档首页：http://localhost:3030。

2. 运行 Web 客户端与 API 服务

# 同时启动前端 Vite 开发服务器与 Go API
task dev

前端开发服务器将运行在 http://localhost:1420，并通过同源代理 /api/* 连接后端 Go API（http://localhost:8080）。

3. 运行独立校园 CLI（tjucli）

# 构建 tjucli 与 tjucli-server
task cli:build

# 查看 CLI 当前已注册的能力
./cli/bin/tjucli capabilities --json

快速验证命令

在提交代码或进行功能验收前，可以运行以下命令确保基础契约完整：

# 运行便携式通用检查（代码规范、格式化、静态检查）
task check

# 运行前后端核心单元测试
task test

# 运行前端 UI 组件测试
task ui:test

# 运行独立 CLI 模块测试
task cli:test