feat: WWJCloud 企业级全栈框架 v0.3.5 完整更新
🚀 核心更新: - ✅ 完善 NestJS 企业级架构设计 - ✅ 优化配置中心和基础设施层 - ✅ 增强第三方服务集成能力 - ✅ 完善多租户架构支持 - 🎯 对标 Java Spring Boot 和 PHP ThinkPHP 📦 新增文件: - wwjcloud-nest 完整框架结构 - Docker 容器化配置 - 管理后台界面 - 数据库迁移脚本 🔑 Key: ebb38b43ec39f355f071294fd1cf9c42
This commit is contained in:
140
README.md
Normal file
140
README.md
Normal file
@@ -0,0 +1,140 @@
|
||||
# WWJCloud-Nest 🚀
|
||||
|
||||
基于NestJS v11的企业级全栈框架,对标Java Spring Boot和PHP ThinkPHP。
|
||||
|
||||
## 🏗️ 架构设计
|
||||
|
||||
```
|
||||
WWJCloud NestJS企业级架构:
|
||||
|
||||
├── Config层 ✅ 框架配置中心 (NuCloud Config)
|
||||
├── Common层 ✅ 基础设施层 (缓存/日志/监控/异常)
|
||||
├── Vendor层 ✅ 第三方服务集成 (支付/短信/上传/通知)
|
||||
├── Core层 🔄 通用业务逻辑 (会员/装修/字典)
|
||||
└── App层 🔄 具体业务实现 (前台/管理端)
|
||||
```
|
||||
|
||||
## ✨ 核心特性
|
||||
|
||||
- 🎯 **企业级框架**:完整的企业应用开发基础设施
|
||||
- 🔧 **配置中心**:动态配置、热更新、多租户支持
|
||||
- 💰 **支付集成**:微信支付、支付宝、线下支付
|
||||
- 📱 **多渠道支持**:微信、小程序、H5、APP
|
||||
- 🔐 **多租户架构**:SaaS/独立版混合部署
|
||||
- 📊 **监控告警**:日志、指标、链路追踪
|
||||
- 🛠️ **开发工具**:代码生成器、插件系统
|
||||
|
||||
## 🚀 快速开始
|
||||
|
||||
### 环境要求
|
||||
- Node.js 18+
|
||||
- MySQL 8.0+
|
||||
- Redis 6.0+
|
||||
|
||||
### 安装运行
|
||||
|
||||
```bash
|
||||
# 1. 克隆项目
|
||||
git clone <repository-url>
|
||||
cd wwjcloud-nest
|
||||
|
||||
# 2. 安装依赖
|
||||
npm install
|
||||
|
||||
# 3. 启动数据库 (Docker)
|
||||
docker-compose up -d mysql redis
|
||||
|
||||
# 4. 启动应用
|
||||
npm run start
|
||||
|
||||
# 5. 访问应用
|
||||
http://localhost:3001
|
||||
```
|
||||
|
||||
### API测试
|
||||
|
||||
```bash
|
||||
# 健康检查
|
||||
curl http://localhost:3001/
|
||||
|
||||
# 配置状态
|
||||
curl http://localhost:3001/config/status
|
||||
|
||||
# 查询配置
|
||||
curl http://localhost:3001/config/value/WECHAT
|
||||
```
|
||||
|
||||
## 📁 项目结构
|
||||
|
||||
```
|
||||
src/
|
||||
├── config/ # 配置中心
|
||||
├── common/ # 基础设施
|
||||
│ ├── cache/ # 缓存服务
|
||||
│ ├── logging/ # 日志服务
|
||||
│ ├── monitoring/ # 监控服务
|
||||
│ ├── queue/ # 队列服务
|
||||
│ ├── utils/ # 工具类
|
||||
│ └── ...
|
||||
├── vendor/ # 第三方集成
|
||||
│ ├── pay/ # 支付服务
|
||||
│ ├── sms/ # 短信服务
|
||||
│ ├── upload/ # 上传服务
|
||||
│ └── ...
|
||||
├── core/ # 通用业务
|
||||
└── main.ts # 应用入口
|
||||
```
|
||||
|
||||
## 🏪 技术栈
|
||||
|
||||
### 后端技术
|
||||
- **框架**: NestJS 11 + TypeScript
|
||||
- **数据库**: MySQL 8.0 + TypeORM
|
||||
- **缓存**: Redis + BullMQ队列
|
||||
- **文档**: Swagger API文档
|
||||
- **监控**: Prometheus + OpenTelemetry
|
||||
|
||||
### 开发工具
|
||||
- **构建**: Nest CLI + Webpack
|
||||
- **代码质量**: ESLint + Prettier
|
||||
- **测试**: Jest + Supertest
|
||||
- **容器**: Docker + Docker Compose
|
||||
|
||||
## 🌟 对标说明
|
||||
|
||||
| 特性 | 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 |
|
||||
|
||||
## 📖 开发文档
|
||||
|
||||
- [架构设计文档](./ARCHITECTURE.md)
|
||||
- [迁移指南](./MIGRATION_GUIDE.md)
|
||||
- [开发计划](./DEVELOPMENT_PLAN.md)
|
||||
|
||||
## 🤝 贡献指南
|
||||
|
||||
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
|
||||
|
||||
## 📄 许可证
|
||||
|
||||
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
|
||||
|
||||
## 👥 团队
|
||||
|
||||
- **架构师**: WWJCloud团队
|
||||
- **开发者**: NestJS企业级开发团队
|
||||
- **产品经理**: SaaS平台产品团队
|
||||
|
||||
---
|
||||
|
||||
⭐ 如果这个项目对你有帮助,请给它一个星星!
|
||||
Reference in New Issue
Block a user