docs: 更新为 AI Assistant Starter 模板

重大变更:
- 将项目定位从单一助手改为 Starter 模板
- 添加详细的使用指南和配置清单
- 说明如何克隆模板创建新助手
- 列出适用场景和技术栈参考

新增内容:
- 🚀 快速开始指南(克隆→配置→推送)
- 📝 配置清单(CLAUDE.md、README.md、文档)
- 🎯 适用场景(全栈Web、管理后台、API服务)
- 📖 使用示例(Vue助手、Python助手等)

核心价值:
- 开箱即用的 AI 助手模板
- 9个全局技能 + 9个本地技能
- 完整的 D8D MCP + BMAD 工作流
- 无需重复配置,直接克隆使用

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Claude AI
2026-03-28 08:28:28 +00:00
parent 2954931300
commit 0c8cdda480

385
README.md
View File

@@ -1,112 +1,289 @@
# Next.js 管理后台开发助手 🤖
# AI Assistant Starter 🚀
基于 Claude Code 的智能 Next.js 管理后台开发助手,专门用于构建完整的前后台应用系统。
**Web 应用类 AI 助手快速启动模板** - 包含完整的配置、技能和文档,开箱即用!
## 📋 项目概述
## 🎯 项目定位
这是一个 AI Agent 项目,通过 `CLAUDE.md` 配置文件定义了专门的 Next.js 开发助手职责和能力。
### 🎯 主要功能
-**前台开发**: React + Next.js + TypeScript + Tailwind CSS
-**管理后台**: 仪表板设计 + 数据可视化
-**API 开发**: Next.js API Routes + Prisma ORM
-**数据库**: PostgreSQL + Prisma
-**代码质量**: TypeScript + React 代码审查
## 🔧 开发环境
- **工作空间**: AI Agent Workspace (ID: 223)
- **模板**: Next.js 管理后台模板 (ID: 242)
- **容器**: D8D 开发容器
- **技能系统**: 已安装 9 个核心开发技能
## 📦 已安装技能
| 技能名称 | 用途 | 安装量 |
|---------|------|--------|
| vercel-react-best-practices | React 最佳实践 | 256.8K 🔥 |
| nextjs-app-router-patterns | Next.js App Router | 10.4K |
| typescript-advanced-types | TypeScript 高级类型 | 18.6K |
| tailwind-design-system | Tailwind CSS 设计系统 | 25.1K |
| prisma-database-setup | Prisma 数据库设置 | 3.4K |
| prisma-client-api | Prisma Client API | 3K |
| kpi-dashboard-design | KPI 仪表板设计 | 4.7K |
| fullstack-developer | 全栈开发者 | 3.6K |
| typescript-react-reviewer | TypeScript React 审查 | 3.9K |
## 🚀 快速开始
### 1. 技能优先策略
AI 助手在执行任务前会先查询是否有相关技能可用:
```bash
# 查询技能
npx skills find <关键词>
# 列出已安装技能
npx skills list -g
# 安装新技能
npx skills add <owner/repo> -g
```
### 2. 开发容器
助手会通过以下工具与开发容器交互:
- `d8d_invoke_dev_container_subagent` - 调用容器中的 Claude 子代理
- `d8d_exec_dev_container_command` - 执行容器命令
- `d8d_get_dev_container_status` - 查看容器状态
### 3. 容器访问地址
- VSCode: `d8d-ai-vscode-23964-223-242-template-6-group.dev.d8d.fun`
- 应用端口: `d8d-ai-vscode-8080-223-242-template-6-group.dev.d8d.fun`
## 📁 项目结构
```
.
├── CLAUDE.md # AI 助手配置文件(核心)
├── README.md # 项目说明文档
├── .gitignore # Git 忽略规则
└── logs/ # 日志目录
```
## 🎓 AI 助手配置
`CLAUDE.md` 文件定义了助手的核心能力:
- **触发方式**: 私聊直接对话,群聊使用 `@nextjs-admin`
- **技术栈**: React、Next.js、TypeScript、Tailwind CSS
- **职责范围**: 在工作空间 223 的模板 242 中进行开发
- **技能优先**: 优先使用现有技能而非手动实现
## 📝 提交规范
项目遵循 Conventional Commits 规范:
- `feat:` 新功能
- `docs:` 文档更新
- `fix:` Bug 修复
- `refactor:` 代码重构
- `test:` 测试相关
- `chore:` 构建/工具链相关
## 🔗 相关链接
- **Gitea 仓库**: https://gitea.d8d.fun/d8dfun/nextjs-admin-assistant
- **D8D 平台**: 工作空间 223
- **技能市场**: https://skills.sh/
## 📄 许可证
本项目基于 MIT 许可证开源。
这是一个 **AI 助手开发模板仓库**,专门用于快速创建 Web 应用类 AI 助手。以后创建新的 AI 助手时,直接克隆这个仓库,修改配置即可使用,无需重复配置!
---
**开发者**: d8dfun
## ✨ 模板特性
### 📦 开箱即用
-**完整的 CLAUDE.md 配置** - D8D MCP 工具、BMAD 工作流、技能系统
-**9 个精选开发技能** - 文档处理、AI 助手、开发工具
-**模板概述文档** - 完整的项目说明和使用指南
-**Git 仓库配置** - .gitignore、提交规范
### 🎓 技能系统
**全局技能9个** - 通过 npx skills 安装:
- vercel-react-best-practices (256.8K 🔥)
- nextjs-app-router-patterns
- typescript-advanced-types
- tailwind-design-system
- prisma-database-setup
- prisma-client-api
- kpi-dashboard-design
- fullstack-developer
- typescript-react-reviewer
**本地技能9个** - .claude/skills/
- 📊 **文档处理**: docx, pptx, pdf, xlsx
- 🤖 **AI 助手**: new-conversation, skill-creator
- 🔧 **开发工具**: mcp-builder, mcp-container-install-bmad
- 🎨 **原型生成**: generate-prototype-grid
---
## 🚀 如何使用此模板创建新 AI 助手
### 方法 1: 克隆模板(推荐)
```bash
# 1. 克隆 starter 模板
git clone https://gitea.d8d.fun/d8dfun/ai-assistant-starter.git my-new-assistant
# 2. 进入项目目录
cd my-new-assistant
# 3. 修改配置文件
# - 编辑 CLAUDE.md修改助手名称、职责、模板ID等
# - 编辑 README.md修改项目说明
# - 编辑 docs/ 下的文档:更新模板信息
# 4. 初始化为新仓库
rm -rf .git
git init
git add .
git commit -m "feat: 初始化 [你的助手名称]"
# 5. 推送到新仓库
git remote add origin <你的新仓库地址>
git push -u origin main
```
### 方法 2: 从现有项目复制配置
```bash
# 1. 复制配置文件
cp -r ai-assistant-starter/.claude/ my-project/
cp ai-assistant-starter/CLAUDE.md my-project/
cp ai-assistant-starter/README.md my-project/
cp ai-assistant-starter/.gitignore my-project/
# 2. 根据你的项目修改配置
```
---
## 📝 配置清单
创建新 AI 助手时,需要修改以下内容:
### 1. **CLAUDE.md** - 核心配置文件
```markdown
# 修改以下内容:
# 1. 标题和角色名称
# 原: # Next.js 管理后台开发助手
# 改: # [你的助手名称]
# 2. 触发方式
# 原: group chat: Users mention you using `@nextjs-admin`
# 改: group chat: Users mention you using `@[你的触发词]`
# 3. 能力描述
# 原: 专门帮助开发Next.js管理后台的AI助手
# 改: 专门帮助[你的专业领域]的AI助手
# 4. 职责范围
# 原: 在工作空间ID 223 的模板ID 242 中进行Next.js管理后台开发
# 改: 在工作空间ID [XXX] 的模板ID [XXX] 中进行[你的项目]开发
# 5. 开发环境信息
# 修改工作空间ID、模板ID、容器访问地址
```
### 2. **README.md** - 项目说明
```markdown
# 修改以下内容:
# 1. 项目标题和描述
# 2. 开发环境信息
# 3. 技能清单
# 4. 相关链接
```
### 3. **docs/template-XXX-overview.md** - 模板概述
```markdown
# 创建新的模板概述文档,包含:
- 基本信息模板ID、访问地址
- 项目定位
- 技术栈
- 项目结构
- 快速开始指南
```
---
## 🛠️ 技术栈参考
此模板适用于以下技术栈的 AI 助手:
### 前端框架
- ✅ Next.js (App Router)
- ✅ React 19
- ✅ Vue 3
- ✅ Nuxt 3
### 后端框架
- ✅ NestJS
- ✅ Express
- ✅ FastAPI
- ✅ Django
### 数据库
- ✅ PostgreSQL + Prisma
- ✅ MongoDB + Mongoose
- ✅ MySQL
- ✅ Redis
### 样式方案
- ✅ Tailwind CSS
- ✅ Ant Design
- ✅ Element Plus
- ✅ Material-UI
---
## 📚 完整功能清单
### D8D MCP 工具集成
- ✅ 容器控制(启动/停止/检查)
- ✅ 子代理交互(核心开发方式)
- ✅ 命令执行
- ✅ 对话历史管理
### BMAD 工作流系统
- ✅ 完整的 BMAD Method 说明
- ✅ 核心技能bmad-help, bmad-quick-spec, bmad-dev-story
- ✅ 专家 AgentPM, Architect, Developer, Scrum Master
- ✅ 工作流技能PRD、架构、史诗、故事
### 技能系统
- ✅ 技能优先策略
- ✅ 技能查询和安装
- ✅ 使用场景说明
---
## 🎯 适用场景
此模板适合创建以下类型的 AI 助手:
### ✅ 推荐使用
- 📱 **全栈 Web 应用** - Next.js、React、Vue 等
- 🎨 **管理后台系统** - 仪表板、CRUD、数据管理
- 🔌 **API 服务** - RESTful、GraphQL、微服务
- 🗄️ **数据库驱动** - Prisma、SQL、NoSQL
### ⚠️ 不推荐使用
- ❌ 移动应用React Native、Flutter
- ❌ 桌面应用Electron、Tauri
- ❌ 游戏开发Unity、Unreal
- ❌ AI/ML 模型训练
- ❌ DevOps/基础设施
---
## 📖 使用示例
### 示例 1: 创建 Vue 管理后台助手
```bash
# 1. 克隆模板
git clone https://gitea.d8d.fun/d8dfun/ai-assistant-starter.git vue-admin-assistant
cd vue-admin-assistant
# 2. 修改 CLAUDE.md
# - 标题改为: "# Vue 管理后台开发助手"
# - 触发词改为: @vue-admin
# - 技术栈改为: Vue 3 + Nuxt 3 + TypeScript
# - 模板ID改为: 你的模板ID
# 3. 修改 README.md
# - 更新项目描述和链接
# 4. 推送到新仓库
git remote set-url origin https://gitea.d8d.fun/d8dfun/vue-admin-assistant.git
git push -u origin main
```
### 示例 2: 创建 Python API 助手
```bash
# 1. 克隆模板
git clone https://gitea.d8d.fun/d8dfun/ai-assistant-starter.git python-api-assistant
cd python-api-assistant
# 2. 修改配置
# - CLAUDE.md: Python + FastAPI + SQLAlchemy
# - 技能系统: 移除前端技能,添加 Python 相关技能
# 3. 推送
git push -u origin main
```
---
## 🔗 相关链接
- **Gitea 仓库**: https://gitea.d8d.fun/d8dfun/ai-assistant-starter
- **问题反馈**: https://gitea.d8d.fun/d8dfun/ai-assistant-starter/issues
- **技能市场**: https://skills.sh/
---
## 📄 许可证
MIT License - 自由使用、修改和分发
---
## 🙏 致谢
本模板由以下项目启发:
- D8D 平台 - 开发容器和 MCP 工具
- BMAD - 敏捷 AI 驱动开发工作流
- Vercel - React 最佳实践
- Claude Code - AI 开发助手
---
**维护者**: d8dfun
**创建时间**: 2026-03-28
**最后更新**: 2026-03-28
**AI 助手**: Claude Sonnet 4.6
---
## 🎉 快速开始
```bash
# 一键克隆
git clone https://gitea.d8d.fun/d8dfun/ai-assistant-starter.git
# 三步配置
# 1. 修改 CLAUDE.md助手配置
# 2. 修改 README.md项目说明
# 3. 推送到你的仓库
# 开始使用!
🚀
```