flnxi-Wu/scripts/README.md
WuYongJie f646b71813
Some checks failed
CI Check / check (push) Has been cancelled
chore: 初始化本地仓库并同步最近改动
2025-11-18 17:50:16 +08:00

59 lines
1.8 KiB
Markdown

# Scripts 目录说明
## 📁 目录结构
```
scripts/
├── deploy/ # 部署脚本(生产环境使用)
├── tools/ # 工具脚本(开发维护使用)
└── temp/ # 临时脚本(可随时清理)
```
## 🚀 部署脚本 (deploy/)
**生产环境部署使用:**
- `安全部署.ps1` / `安全部署.sh`:标准化部署流程
- `deploy-now.ps1`、`deploy-optimized.ps1`:包含 Docker 重构与健康检查
- `local-build-and-upload.ps1`:本地构建/打包镜像并通过 `scp` 上传
- `update-admin-account.js`:一键修改管理员邮箱与密码
**使用流程:**
1. 本地测试:`npm run dev`
2. 部署前检查:`./部署前检查清单.bat`
3. 执行部署:`./scripts/deploy/安全部署.ps1`
4. 远程部署可参考 `deploy/README.md` 内的 SSH 模版
## 🛠️ 工具脚本 (tools/)
**开发维护使用:**
- 数据库备份/恢复脚本
- 环境配置与诊断脚本
- 常用工具脚本(如 `quick-start.sh`、`start.sh`)用于快速拉起容器
## 🗑️ 临时脚本 (temp/)
**临时文件和废弃脚本:**
- 一次性使用或测试脚本
- 已被替代的旧脚本
**建议:** 用完即删,保持目录整洁。
## 📋 文件管理原则
1. **只保留必要的脚本**,删除过期内容。
2. **临时脚本用完即删**,避免堆积。
3. **按用途分类**,部署/工具/临时分离。
4. **保持整洁**,定期自检。
5. **对齐 Docker 流程**,容器部署统一使用 `docker-compose.yml` / `docker-compose.dev.yml`。
## ⚠️ 注意事项
- 部署脚本只传输项目必要文件(通常通过 Docker 镜像)。
- 临时文件、文档、脚本不会上传到服务器。
- 使用 `.dockerignore` 控制 Docker 构建上下文,减少无关内容。