create-dp-koa 1.0.0

package/template/README.md

@@ -0,0 +1,229 @@
+# DP-Koa Framework
+
+一个基于 Koa.js 的企业级 Node.js 框架，提供完整的后端开发解决方案。
+
+## 📋 目录
+
+- [快速开始](#快速开始)
+- [项目特性](#项目特性)
+- [文档导航](#文档导航)
+- [技术栈](#技术栈)
+- [系统要求](#系统要求)
+- [安装与配置](#安装与配置)
+- [开发指南](#开发指南)
+- [API 文档](#api-文档)
+- [部署指南](#部署指南)
+- [故障排除](#故障排除)
+- [贡献指南](#贡献指南)
+- [许可证](#许可证)
+
+## 🚀 快速开始
+
+### 环境要求
+
+- Node.js >= 18.0.0
+- npm >= 8.0.0
+- MySQL >= 8.0 或 SQLite3
+- Redis (可选，用于缓存)
+
+### 一键启动
+
+#### 使用 npm 脚手架（推荐）
+
+从 npm 安装官方模板并生成新项目（需已安装 Node.js 与 npm）：
+
+```bash
+npm create dp-koa@latest
+# 或指定目录名：npx create-dp-koa@latest my-app
+cd my-app
+
+npm install
+cp env.production.example .env
+npm run dev
+```
+
+将 `my-app` 换为你创建时使用的目录名。
+
+#### 克隆源码仓库
+
+框架源码托管在 Gitee，**克隆请使用 SSH**：
+
+```bash
+git clone git@gitee.com:rajan_admin/dp-koa-framework.git
+cd dp-koa-framework
+
+npm install
+cp env.production.example .env
+npm run dev
+```
+
+未配置 SSH 时，可在 Gitee 网页复制 HTTPS 地址作为备用。
+
+访问 `http://localhost:3000` 查看应用运行状态。
+
+#### 维护者：发布脚手架新版本
+
+在推送代码到远程后，于仓库根目录更新模板并发布 `packages/create-dp-koa`：
+
+```bash
+npm run sync:create-template
+cd packages/create-dp-koa
+npm version patch   # 或 minor / major
+npm publish
+```
+
+`npm publish` 前会执行 `prepublishOnly` 再次同步模板；若已手动执行 `sync:create-template`，保持版本与内容一致即可。
+
+## ✨ 项目特性
+
+### 🏗️ 核心架构
+- **模块化设计**: 基于依赖注入的模块化架构
+- **注解系统**: 强大的装饰器注解系统，简化开发
+- **拦截器**: 灵活的请求/响应拦截机制
+- **事务管理**: 完整的数据库事务支持
+
+### 🛠️ 开发工具
+- **TypeScript**: 完整的类型支持
+- **Swagger**: 自动生成 API 文档
+- **Jest**: 全面的测试覆盖
+- **ESLint**: 代码质量检查
+
+### 🔒 企业级特性
+- **安全认证**: JWT + bcrypt 安全认证
+- **日志系统**: 结构化日志记录
+- **缓存管理**: 多级缓存策略
+- **监控告警**: 性能监控和健康检查
+
+### 🚀 部署支持
+- **Docker**: 容器化部署
+- **Docker Compose**: 多服务编排
+- **Nginx**: 负载均衡和反向代理
+- **监控**: Prometheus + Grafana
+
+## 📚 文档导航
+
+### 📖 文档索引
+- [📋 文档索引](docs/DOCUMENTATION_INDEX.md) - 完整文档导航
+- [📁 文档结构](docs/DOCUMENTATION_STRUCTURE.md) - 文档体系说明
+
+### 🚀 快速开始
+- [⚡ 快速开始指南](docs/QUICK_START.md) - 5分钟快速上手
+- [🔧 安装配置指南](docs/INSTALLATION_GUIDE.md) - 详细安装步骤
+- [⚙️ 环境配置说明](docs/ENVIRONMENT_CONFIG_EXAMPLE.md) - 环境变量配置
+
+### 💻 开发文档
+- [👨‍💻 开发指南](docs/DEVELOPMENT_GUIDE.md) - 开发规范和最佳实践
+- [📖 API 文档](docs/API_DOCUMENTATION.md) - 完整的 API 参考
+- [🎯 注解系统指南](docs/ENTERPRISE_ANNOTATION_SYSTEM_GUIDE.md) - 注解使用说明
+- [🏗️ 服务层指南](docs/SERVICE_PATTERN_GUIDE.md) - 服务层设计模式
+
+### 🏛️ 架构文档
+- [🗄️ 数据库架构](docs/ENTERPRISE_DATABASE_ARCHITECTURE.md) - 数据库设计
+- [🔄 拦截器指南](docs/SERVICE_INTERCEPTOR_GUIDE.md) - 拦截器使用
+- [💾 事务管理](docs/TRANSACTION_MANAGER_USAGE.md) - 事务处理
+- [📊 日志系统](docs/ENTERPRISE_LOGGING_SYSTEM_GUIDE.md) - 日志配置
+
+### 🚀 部署文档
+- [☁️ 部署指南](docs/DEPLOYMENT_GUIDE.md) - 生产环境部署
+- [🐳 企业级部署](docs/ENTERPRISE_DEPLOYMENT_GUIDE.md) - 企业级部署方案
+- [📈 监控配置](docs/DEPLOYMENT_GUIDE.md#监控配置) - 监控系统配置
+
+### 🧪 测试文档
+- [🔬 测试指南](docs/TESTING_GUIDE.md) - 测试策略和工具
+- [📋 拦截器测试](docs/INTERCEPTOR_TESTING_REPORT.md) - 拦截器测试报告
+
+### 🆘 故障排除
+- [🔍 故障排除指南](docs/TROUBLESHOOTING.md) - 常见问题解决
+- [⚠️ 错误处理指南](docs/ENTERPRISE_ERROR_HANDLING_GUIDE.md) - 错误处理策略
+
+## 🛠️ 技术栈
+
+### 后端框架
+- **Koa.js**: 轻量级 Web 框架
+- **TypeScript**: 类型安全的 JavaScript
+- **TypeORM**: 对象关系映射
+
+### 数据库
+- **MySQL**: 主数据库
+- **SQLite**: 开发/测试数据库
+- **Redis**: 缓存和会话存储
+
+### 开发工具
+- **Jest**: 测试框架
+- **ESLint**: 代码检查
+- **Webpack**: 模块打包
+- **Swagger**: API 文档
+
+### 部署工具
+- **Docker**: 容器化
+- **Nginx**: Web 服务器
+- **Prometheus**: 监控
+- **Grafana**: 可视化
+
+## 📋 系统要求
+
+### 开发环境
+- Node.js 18.0.0+
+- npm 8.0.0+
+- MySQL 8.0+ 或 SQLite3
+- Git
+
+### 生产环境
+- Node.js 18.0.0+
+- MySQL 8.0+
+- Redis 6.0+
+- Docker 20.0+
+- Nginx 1.18+
+
+## 🔧 安装与配置
+
+详细的安装和配置步骤请参考：
+- [安装配置指南](docs/INSTALLATION_GUIDE.md)
+- [环境配置说明](docs/ENVIRONMENT_CONFIG_EXAMPLE.md)
+
+## 💻 开发指南
+
+开发相关文档：
+- [开发指南](docs/DEVELOPMENT_GUIDE.md)
+- [注解系统指南](docs/ENTERPRISE_ANNOTATION_SYSTEM_GUIDE.md)
+- [服务层指南](docs/SERVICE_PATTERN_GUIDE.md)
+
+## 📖 API 文档
+
+API 相关文档：
+- [API 文档](docs/API_DOCUMENTATION.md)
+- [Swagger 集成指南](docs/SWAGGER_INTEGRATION_GUIDE.md)
+
+## 🚀 部署指南
+
+部署相关文档：
+- [部署指南](docs/ENTERPRISE_DEPLOYMENT_GUIDE.md)
+- [Docker 部署](docs/DOCKER_DEPLOYMENT.md)
+
+## 🔍 故障排除
+
+遇到问题？查看：
+- [故障排除指南](docs/TROUBLESHOOTING.md)
+- [错误处理指南](docs/ENTERPRISE_ERROR_HANDLING_GUIDE.md)
+
+## 🤝 贡献指南
+
+欢迎贡献代码！请查看：
+- [贡献指南](docs/CONTRIBUTING.md)
+- [代码规范](docs/CODE_STANDARDS.md)
+
+## 📄 许可证
+
+本项目采用 ISC 许可证。详情请查看 [LICENSE](LICENSE) 文件。
+
+## 📞 支持
+
+- 📧 邮箱: support@example.com
+- 🐛 问题反馈: [GitHub Issues](https://github.com/your-repo/issues)
+- 📖 文档: [在线文档](https://your-docs-site.com)
+
+---
+
+**快速链接**:
+- [快速开始](docs/QUICK_START.md) | [安装指南](docs/INSTALLATION_GUIDE.md) | [开发指南](docs/DEVELOPMENT_GUIDE.md)
+- [API 文档](docs/API_DOCUMENTATION.md) | [部署指南](docs/ENTERPRISE_DEPLOYMENT_GUIDE.md) | [故障排除](docs/TROUBLESHOOTING.md)

package/template/docker-compose.yml

@@ -0,0 +1,135 @@
+# Docker Compose配置 - 企业级应用部署
+
+version: '3.8'
+
+services:
+  # 主应用服务
+  app:
+    build: .
+    ports:
+      - "3000:3000"
+    environment:
+      - NODE_ENV=production
+      - PORT=3000
+      - DB_HOST=mysql
+      - DB_PORT=3306
+      - DB_USERNAME=app_user
+      - DB_PASSWORD=app_password
+      - DB_DATABASE=app_db
+    depends_on:
+      mysql:
+        condition: service_healthy
+      redis:
+        condition: service_started
+    restart: unless-stopped
+    networks:
+      - app-network
+    volumes:
+      - ./logs:/app/logs
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:3000/health"]
+      interval: 30s
+      timeout: 10s
+      retries: 3
+      start_period: 40s
+
+  # MySQL数据库
+  mysql:
+    image: mysql:8.0
+    environment:
+      - MYSQL_ROOT_PASSWORD=root_password
+      - MYSQL_DATABASE=app_db
+      - MYSQL_USER=app_user
+      - MYSQL_PASSWORD=app_password
+    ports:
+      - "3306:3306"
+    volumes:
+      - mysql_data:/var/lib/mysql
+      - ./docker/mysql/init:/docker-entrypoint-initdb.d
+    restart: unless-stopped
+    networks:
+      - app-network
+    healthcheck:
+      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
+      interval: 10s
+      timeout: 5s
+      retries: 5
+      start_period: 30s
+
+  # Redis缓存
+  redis:
+    image: redis:7-alpine
+    ports:
+      - "6379:6379"
+    volumes:
+      - redis_data:/data
+    restart: unless-stopped
+    networks:
+      - app-network
+    command: redis-server --appendonly yes --requirepass redis_password
+    healthcheck:
+      test: ["CMD", "redis-cli", "--raw", "incr", "ping"]
+      interval: 10s
+      timeout: 3s
+      retries: 5
+
+  # Nginx负载均衡器
+  nginx:
+    image: nginx:alpine
+    ports:
+      - "80:80"
+      - "443:443"
+    volumes:
+      - ./docker/nginx/nginx.conf:/etc/nginx/nginx.conf
+      - ./docker/nginx/ssl:/etc/nginx/ssl
+    depends_on:
+      - app
+    restart: unless-stopped
+    networks:
+      - app-network
+
+  # Prometheus监控
+  prometheus:
+    image: prom/prometheus:latest
+    ports:
+      - "9090:9090"
+    volumes:
+      - ./docker/prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
+      - prometheus_data:/prometheus
+    command:
+      - '--config.file=/etc/prometheus/prometheus.yml'
+      - '--storage.tsdb.path=/prometheus'
+      - '--web.console.libraries=/etc/prometheus/console_libraries'
+      - '--web.console.templates=/etc/prometheus/consoles'
+      - '--storage.tsdb.retention.time=200h'
+      - '--web.enable-lifecycle'
+    restart: unless-stopped
+    networks:
+      - app-network
+
+  # Grafana仪表板
+  grafana:
+    image: grafana/grafana:latest
+    ports:
+      - "3001:3000"
+    environment:
+      - GF_SECURITY_ADMIN_PASSWORD=admin_password
+    volumes:
+      - grafana_data:/var/lib/grafana
+      - ./docker/grafana/provisioning:/etc/grafana/provisioning
+    depends_on:
+      - prometheus
+    restart: unless-stopped
+    networks:
+      - app-network
+
+volumes:
+  mysql_data:
+  redis_data:
+  prometheus_data:
+  grafana_data:
+
+networks:
+  app-network:
+    driver: bridge
+