c97d301e8f
- 从仓库中移除 backup-*.jsonl 备份文件 - 移除 ai-team-dashboard-v1.5.0.tar.gz 压缩包 - 移除 ai-team-dashboard-v1.5.0-README.txt - 更新 .gitignore 排除备份和压缩包文件 - 添加推送相关文档 Made-with: Cursor
177 lines
4.3 KiB
Markdown
177 lines
4.3 KiB
Markdown
# 推送到 GitHub 指南
|
||
|
||
## 📋 准备工作
|
||
|
||
已完成：
|
||
- ✅ 初始化 Git 仓库
|
||
- ✅ 添加 .gitignore（排除敏感信息）
|
||
- ✅ 创建 2 个 commits
|
||
- ✅ 隐去所有隐私信息（Token、密钥等）
|
||
|
||
## 🚀 推送步骤
|
||
|
||
### 1. 在 GitHub 上创建仓库
|
||
|
||
访问：https://github.com/new
|
||
|
||
- Repository name: `ai-team-dashboard`（或你喜欢的名字）
|
||
- Description: `AI Team Dashboard - 功能强大的 AI 开发团队协作平台`
|
||
- 选择 Public 或 Private
|
||
- **不要**勾选 "Initialize this repository with a README"（我们已经有了）
|
||
|
||
### 2. 添加远程仓库
|
||
|
||
将 GitHub 上创建的仓库地址替换到下面的命令中：
|
||
|
||
```bash
|
||
cd /Users/fang/Desktop/ai-team
|
||
|
||
# 添加远程仓库（替换为你的仓库地址）
|
||
git remote add origin https://github.com/你的用户名/仓库名.git
|
||
|
||
# 或使用 SSH（如果配置了 SSH key）
|
||
# git remote add origin git@github.com:你的用户名/仓库名.git
|
||
```
|
||
|
||
### 3. 推送到 GitHub
|
||
|
||
```bash
|
||
# 推送到 main 分支
|
||
git push -u origin main
|
||
```
|
||
|
||
### 4. 验证
|
||
|
||
访问你的 GitHub 仓库页面，确认：
|
||
- ✅ README.md 正确显示
|
||
- ✅ 没有 config.json（只有 config.json.example）
|
||
- ✅ 没有 logs/ 目录
|
||
- ✅ 没有 .pid 文件
|
||
- ✅ 所有脚本和文档都已上传
|
||
|
||
## 📝 已创建的 Commits
|
||
|
||
### Commit 1: 主要功能
|
||
```
|
||
feat: 添加 Dashboard 完整日志监控系统 v1.1.0
|
||
|
||
✨ 新增功能
|
||
- 完整的日志记录系统（6 种日志级别）
|
||
- 日志配置功能（可通过 config.json 控制）
|
||
- 性能监控装饰器和请求日志中间件
|
||
- 7 个管理工具脚本
|
||
- 完整的文档和使用指南
|
||
...
|
||
```
|
||
|
||
### Commit 2: README
|
||
```
|
||
docs: 添加项目 README 文档
|
||
```
|
||
|
||
## 🔒 安全检查清单
|
||
|
||
推送前请确认：
|
||
- ✅ config.json 不在 Git 中（被 .gitignore 排除）
|
||
- ✅ logs/ 目录不在 Git 中
|
||
- ✅ *.log 文件不在 Git 中
|
||
- ✅ *.pid 文件不在 Git 中
|
||
- ✅ config.json.example 使用占位符（无真实 Token）
|
||
|
||
验证命令：
|
||
```bash
|
||
# 检查是否有敏感文件
|
||
git ls-files | grep -iE '(config\.json$|\.log|\.pid|token|secret|key)'
|
||
|
||
# 如果没有输出，说明没有敏感文件
|
||
```
|
||
|
||
## 📚 仓库内容
|
||
|
||
推送后的仓库结构：
|
||
```
|
||
ai-team-dashboard/
|
||
├── README.md # 项目说明
|
||
├── CHANGELOG_v1.1.0.md # 更新日志
|
||
├── .gitignore # Git 忽略文件
|
||
├── dashboard/ # Dashboard 目录
|
||
│ ├── server.js # 后端服务
|
||
│ ├── config.json.example # 配置模板（无敏感信息）
|
||
│ ├── *.sh # 管理脚本
|
||
│ ├── *.md # 文档
|
||
│ └── public/ # 前端页面
|
||
├── bots/ # Bot 配置
|
||
├── scripts/ # 工具脚本
|
||
└── docker-compose.yml # Docker 编排
|
||
|
||
不包含（被 .gitignore 排除）：
|
||
- config.json（含 Token、密钥）
|
||
- logs/（日志文件）
|
||
- *.log（日志文件）
|
||
- *.pid（进程 ID）
|
||
```
|
||
|
||
## 🎯 推送后的工作
|
||
|
||
### 1. 更新本地配置
|
||
|
||
确保 `config.json` 配置正确：
|
||
```bash
|
||
cd dashboard
|
||
cp config.json.example config.json
|
||
vim config.json # 填入你的真实配置
|
||
```
|
||
|
||
### 2. 启动服务
|
||
|
||
```bash
|
||
./start-with-log.sh
|
||
```
|
||
|
||
### 3. 分享项目
|
||
|
||
在 GitHub 仓库页面：
|
||
1. 编辑 About（右侧）添加描述和标签
|
||
2. 添加 Topics（如：dashboard, ai, monitoring, nodejs）
|
||
3. 如果是开源项目，可以添加 LICENSE 文件
|
||
|
||
## 💡 常见问题
|
||
|
||
### Q: 推送时要求输入用户名和密码
|
||
|
||
A: 如果使用 HTTPS，需要输入 GitHub 用户名和 Personal Access Token（不是密码）。
|
||
|
||
生成 Token：
|
||
1. 访问 https://github.com/settings/tokens
|
||
2. 点击 "Generate new token (classic)"
|
||
3. 勾选 `repo` 权限
|
||
4. 生成并复制 Token
|
||
|
||
或者配置 SSH key 使用 SSH 方式推送。
|
||
|
||
### Q: 提示 "Permission denied"
|
||
|
||
A: 确保你有仓库的写入权限，或者使用 SSH 方式推送。
|
||
|
||
### Q: 如何更新已推送的内容？
|
||
|
||
A:
|
||
```bash
|
||
# 修改文件后
|
||
git add .
|
||
git commit -m "update: 你的更新说明"
|
||
git push
|
||
```
|
||
|
||
## 🎉 完成！
|
||
|
||
推送成功后，你的项目就在 GitHub 上了！
|
||
|
||
可以：
|
||
- 📢 分享给团队成员
|
||
- 📝 继续开发新功能
|
||
- 🐛 接收和处理 Issues
|
||
- 🤝 接受 Pull Requests
|
||
|
||
祝使用愉快！🦞
|