Quick Deploy Toolkit

通用快速部署工具包 - 基于现有Vue3+NestJS项目的成功经验，支持多种前后端技术栈组合的Docker化部署解决方案。

功能特性

• 🚀 一键初始化项目部署配置
• 🔧 支持多种前后端技术栈组合
• 🐳 自动生成Docker配置
• 📦 GitLab CI/CD自动部署
• 🔄 智能构建和部署策略
• 📊 健康检查和监控
• 🛡️ 安全配置和最佳实践

支持的技术栈

前端框架

• Vue 3 + Vite + Element Plus
• React + Vite + Ant Design
• Angular + TypeScript
• Next.js (React)
• Nuxt.js (Vue)

后端框架

• NestJS + TypeScript + MySQL
• Express + TypeScript + MySQL
• Koa + TypeScript + MySQL
• Spring Boot + Java + MySQL
• Django + Python + PostgreSQL

快速开始

安装

全局安装（推荐）

npm install -g quick-deploy-kit

项目内安装

npm install --save-dev quick-deploy-kit

快速开始

🚀 一键启动（推荐）

# 全局安装后直接使用
quick-deploy

# 或使用短命令
qdt

# 选择 "完整工作流程" 获得最佳体验

📋 分步操作

📋 命令行使用

1. 初始化新项目

# 初始化新项目
quick-deploy init my-project

# 使用特定模板
quick-deploy init my-project --template vue3-nestjs

# 强制覆盖现有文件
quick-deploy init my-project --force

2. 验证配置

# 验证当前目录的配置
quick-deploy validate

# 验证指定项目的配置
quick-deploy validate ./my-project

# 自动修复发现的问题
quick-deploy validate --fix

3. 测试部署

# 基础测试（不启动服务）
quick-deploy test

# 完整测试（启动服务进行测试）
quick-deploy test --full

# 生成测试报告
quick-deploy test --report

4. 查看可用模板

# 列出所有可用的技术栈模板
quick-deploy templates

5. 检查系统依赖

# 检查系统依赖
quick-deploy check

🔧 编程接口

const { init, validate, test } = require('quick-deploy-kit');

// 初始化项目
await init({
  projectName: 'my-project',
  frontend: { framework: 'vue3-vite-element' },
  backend: { framework: 'nestjs-typescript-mysql' }
});

// 验证配置
const isValid = await validate('./my-project');

// 测试部署
const testPassed = await test('./my-project', { fullTest: true });

📚 获取帮助

# 查看帮助信息
quick-deploy --help

# 查看特定命令的帮助
quick-deploy init --help
quick-deploy validate --help

目录结构

deploy-toolkit/
├── init.js                 # 初始化脚本
├── templates/              # 配置模板
│   ├── frontend/           # 前端模板
│   ├── backend/            # 后端模板
│   ├── docker/             # Docker配置模板
│   ├── ci/                 # CI/CD模板
│   └── nginx/              # Nginx配置模板
├── scripts/                # 部署脚本
└── docs/                   # 文档

使用说明

详细使用说明请参考 使用指南

开发

本地开发

# 克隆项目
git clone https://github.com/yourusername/quick-deploy-toolkit.git
cd quick-deploy-toolkit

# 安装依赖
npm install

# 构建项目
npm run build

# 运行测试
npm test

# 代码检查
npm run lint

# 本地链接测试
npm link
quick-deploy --help

测试

# 运行所有测试
npm test

# 监听模式运行测试
npm run test:watch

# 生成覆盖率报告
npm test -- --coverage

发布

# 构建和测试
npm run build
npm test

# 发布到npm
npm publish

API文档

Initializer

const { Initializer } = require('quick-deploy-kit');

const initializer = new Initializer({
  projectName: 'my-project',
  template: 'vue3-nestjs',
  force: false,
  quiet: false
});

await initializer.run();

Validator

const { Validator } = require('quick-deploy-kit');

const validator = new Validator({
  projectPath: './my-project',
  autoFix: true,
  generateReport: true
});

const isValid = await validator.validate();

Tester

const { Tester } = require('quick-deploy-kit');

const tester = new Tester({
  projectPath: './my-project',
  fullTest: true,
  generateReport: true
});

const success = await tester.runTests();

贡献

欢迎贡献代码！请遵循以下步骤：

1. Fork 项目
2. 创建功能分支 (git checkout -b feature/amazing-feature)
3. 提交更改 (git commit -m 'Add some amazing feature')
4. 推送到分支 (git push origin feature/amazing-feature)
5. 开启 Pull Request

贡献指南

• 遵循现有的代码风格
• 添加适当的测试
• 更新相关文档
• 确保所有测试通过

许可证

本项目采用 MIT 许可证 - 查看 LICENSE 文件了解详情。

更新日志

v1.0.0

• 初始版本发布
• 支持5种前端框架 × 5种后端框架组合
• 完整的Docker化部署配置生成
• GitLab CI/CD自动部署支持
• 配置验证和测试功能
• 交互式命令行界面

支持

如果你觉得这个项目有用，请给它一个 ⭐️！

• 📧 邮箱: your.email@example.com
• 🐛 问题反馈: GitHub Issues
• 💬 讨论: GitHub Discussions

相关项目

• Docker - 容器化平台
• GitLab CI/CD - 持续集成/持续部署
• Vue.js - 渐进式JavaScript框架
• NestJS - 企业级Node.js框架