2025-10-14 22:48:31 +08:00
|
|
|
|
# WWJCloud-Nest 🚀
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
基于NestJS v11的企业级全栈框架,对标Java Spring Boot和PHP ThinkPHP。
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
## 🏗️ 架构设计
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
|
|
|
|
|
```
|
2025-10-14 22:48:31 +08:00
|
|
|
|
WWJCloud NestJS企业级架构:
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
├── Config层 ✅ 框架配置中心 (NuCloud Config)
|
|
|
|
|
|
├── Common层 ✅ 基础设施层 (缓存/日志/监控/异常)
|
|
|
|
|
|
├── Vendor层 ✅ 第三方服务集成 (支付/短信/上传/通知)
|
|
|
|
|
|
├── Core层 🔄 通用业务逻辑 (会员/装修/字典)
|
|
|
|
|
|
└── App层 🔄 具体业务实现 (前台/管理端)
|
2025-09-21 21:29:28 +08:00
|
|
|
|
```
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
## ✨ 核心特性
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
- 🎯 **企业级框架**:完整的企业应用开发基础设施
|
|
|
|
|
|
- 🔧 **配置中心**:动态配置、热更新、多租户支持
|
|
|
|
|
|
- 💰 **支付集成**:微信支付、支付宝、线下支付
|
|
|
|
|
|
- 📱 **多渠道支持**:微信、小程序、H5、APP
|
|
|
|
|
|
- 🔐 **多租户架构**:SaaS/独立版混合部署
|
|
|
|
|
|
- 📊 **监控告警**:日志、指标、链路追踪
|
|
|
|
|
|
- 🛠️ **开发工具**:代码生成器、插件系统
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
|
|
|
|
|
## 🚀 快速开始
|
|
|
|
|
|
|
|
|
|
|
|
### 环境要求
|
2025-10-14 22:48:31 +08:00
|
|
|
|
- Node.js 18+
|
|
|
|
|
|
- MySQL 8.0+
|
|
|
|
|
|
- Redis 6.0+
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
### 安装运行
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-09-21 21:29:28 +08:00
|
|
|
|
```bash
|
2025-10-14 22:48:31 +08:00
|
|
|
|
# 1. 克隆项目
|
|
|
|
|
|
git clone <repository-url>
|
|
|
|
|
|
cd wwjcloud-nest
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
# 2. 安装依赖
|
|
|
|
|
|
npm install
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
# 3. 启动数据库 (Docker)
|
|
|
|
|
|
docker-compose up -d mysql redis
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
# 4. 启动应用
|
|
|
|
|
|
npm run start
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
# 5. 访问应用
|
|
|
|
|
|
http://localhost:3001
|
2025-08-23 13:20:01 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
### API测试
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
```bash
|
|
|
|
|
|
# 健康检查
|
|
|
|
|
|
curl http://localhost:3001/
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
# 配置状态
|
|
|
|
|
|
curl http://localhost:3001/config/status
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
# 查询配置
|
|
|
|
|
|
curl http://localhost:3001/config/value/WECHAT
|
2025-08-23 13:20:01 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
## 📁 项目结构
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
|
|
|
|
|
```
|
2025-10-14 22:48:31 +08:00
|
|
|
|
src/
|
|
|
|
|
|
├── config/ # 配置中心
|
|
|
|
|
|
├── common/ # 基础设施
|
|
|
|
|
|
│ ├── cache/ # 缓存服务
|
|
|
|
|
|
│ ├── logging/ # 日志服务
|
|
|
|
|
|
│ ├── monitoring/ # 监控服务
|
|
|
|
|
|
│ ├── queue/ # 队列服务
|
|
|
|
|
|
│ ├── utils/ # 工具类
|
|
|
|
|
|
│ └── ...
|
|
|
|
|
|
├── vendor/ # 第三方集成
|
|
|
|
|
|
│ ├── pay/ # 支付服务
|
|
|
|
|
|
│ ├── sms/ # 短信服务
|
|
|
|
|
|
│ ├── upload/ # 上传服务
|
|
|
|
|
|
│ └── ...
|
|
|
|
|
|
├── core/ # 通用业务
|
|
|
|
|
|
└── main.ts # 应用入口
|
2025-08-23 13:20:01 +08:00
|
|
|
|
```
|
|
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
## 🏪 技术栈
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
### 后端技术
|
|
|
|
|
|
- **框架**: NestJS 11 + TypeScript
|
|
|
|
|
|
- **数据库**: MySQL 8.0 + TypeORM
|
|
|
|
|
|
- **缓存**: Redis + BullMQ队列
|
|
|
|
|
|
- **文档**: Swagger API文档
|
|
|
|
|
|
- **监控**: Prometheus + OpenTelemetry
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
### 开发工具
|
|
|
|
|
|
- **构建**: Nest CLI + Webpack
|
|
|
|
|
|
- **代码质量**: ESLint + Prettier
|
|
|
|
|
|
- **测试**: Jest + Supertest
|
|
|
|
|
|
- **容器**: Docker + Docker Compose
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
## 🌟 对标说明
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
| 特性 | Java Spring Boot | PHP ThinkPHP | WWJCloud NestJS |
|
|
|
|
|
|
|-----|------------------|--------------|-----------------|
|
|
|
|
|
|
| 依赖注入 | ✅ Spring IoC | ✅ Container | ✅ NestJS DI |
|
|
|
|
|
|
| 配置管理 | ✅ Application.yml | ✅ Config | ✅ ConfigCenter |
|
|
|
|
|
|
| 数据库ORM | ✅ JPA/MyBatis | ✅ Model | ✅ TypeORM |
|
|
|
|
|
|
| 缓存支持 | ✅ Redisson | ✅ Cache | ✅ Redis |
|
|
|
|
|
|
| 队列系统 | ✅ Rabbit/Active | ✅ Queue | ✅ BullMQ |
|
|
|
|
|
|
| 监控告警 | ✅ Micrometer | ✅ Monitor | ✅ Prometheus |
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
## 📖 开发文档
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
- [架构设计文档](./ARCHITECTURE.md)
|
|
|
|
|
|
- [迁移指南](./MIGRATION_GUIDE.md)
|
|
|
|
|
|
- [开发计划](./DEVELOPMENT_PLAN.md)
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
|
|
|
|
|
## 🤝 贡献指南
|
|
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
1. Fork 项目
|
|
|
|
|
|
2. 创建特性分支 (`git checkout -b feature/amazing-feature`)
|
|
|
|
|
|
3. 提交更改 (`git commit -m 'Add amazing feature'`)
|
|
|
|
|
|
4. 推送到分支 (`git push origin feature/amazing-feature`)
|
|
|
|
|
|
5. 创建 Pull Request
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
|
|
|
|
|
## 📄 许可证
|
|
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
## 👥 团队
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
- **架构师**: WWJCloud团队
|
|
|
|
|
|
- **开发者**: NestJS企业级开发团队
|
|
|
|
|
|
- **产品经理**: SaaS平台产品团队
|
2025-08-23 13:20:01 +08:00
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
2025-10-14 22:48:31 +08:00
|
|
|
|
⭐ 如果这个项目对你有帮助,请给它一个星星!
|