Add documentation and scripts

Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
bujie9527
2026-02-05 16:44:51 +08:00
parent 59275ed4dc
commit df419b499b
6 changed files with 913 additions and 0 deletions

89
CLONE.md Normal file
View File

@@ -0,0 +1,89 @@
# 项目克隆地址和使用说明
## 📦 克隆地址
### HTTPS推荐
```bash
git clone https://github.com/bujie9527/wecom-ai-assistant.git
```
### SSH需要配置 SSH 密钥)
```bash
git clone git@github.com:bujie9527/wecom-ai-assistant.git
```
## 🚀 快速开始
### 1. 克隆项目
```bash
git clone https://github.com/bujie9527/wecom-ai-assistant.git
cd wecom-ai-assistant
```
### 2. 配置环境
```bash
# 复制环境变量模板
cp .env.example .env
# Windows PowerShell
Copy-Item .env.example .env
```
### 3. 启动服务
```bash
docker compose up -d
```
### 4. 访问服务
- 管理后台http://localhost
- 后端 APIhttp://localhost:8000/api/health
## 📚 详细文档
- [Git 克隆和使用指南](./docs/git-clone-guide.md)
- [GitHub 快速开始](./docs/github-quickstart.md)
- [项目 README](./README.md)
## 🔐 推送代码
### 使用 TokenHTTPS
```bash
# 设置远程 URL包含 token
git remote set-url origin https://bujie9527:YOUR_TOKEN@github.com/bujie9527/wecom-ai-assistant.git
# 推送代码
git push origin main
```
### 使用 SSH
```bash
# 配置 SSH 密钥后
git remote set-url origin git@github.com:bujie9527/wecom-ai-assistant.git
git push origin main
```
## 📝 项目信息
- **仓库地址**https://github.com/bujie9527/wecom-ai-assistant
- **默认分支**`main`
- **项目类型**MonorepoBackend + Admin + Deploy
## ⚠️ 注意事项
1. **环境变量**`.env` 文件包含敏感信息,不要提交到 Git
2. **GitHub Token**:推送代码时需要 Personal Access Token
3. **Docker**:确保已安装 Docker 和 docker-compose
## 🆘 获取帮助
- 查看 [Git 克隆指南](./docs/git-clone-guide.md)
- 查看 [GitHub 配置指南](./docs/github-config-guide.md)
- 提交 Issuehttps://github.com/bujie9527/wecom-ai-assistant/issues