docs: 添加项目说明文档
- 完整的项目概述和功能介绍 - 开发环境信息和已安装技能清单 - 快速开始指南和容器访问地址 - AI 助手配置说明和提交规范 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
112
README.md
Normal file
112
README.md
Normal file
@@ -0,0 +1,112 @@
|
||||
# Next.js 管理后台开发助手 🤖
|
||||
|
||||
基于 Claude Code 的智能 Next.js 管理后台开发助手,专门用于构建完整的前后台应用系统。
|
||||
|
||||
## 📋 项目概述
|
||||
|
||||
这是一个 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 许可证开源。
|
||||
|
||||
---
|
||||
|
||||
**开发者**: d8dfun
|
||||
**创建时间**: 2026-03-28
|
||||
**AI 助手**: Claude Sonnet 4.6
|
||||
Reference in New Issue
Block a user