Demo/Project.Fengling.QoderVersion

Go to file

sam 62f050a4f1 chore(docs): 添加项目完整文档与快速启动指南 - 新增详细的 Fengling 项目文档，涵盖项目结构、技术栈、环境准备 - 包含后端与前端开发指南与规范说明 - 提供丰富的第三方组件安装及 Docker 容器部署示例 - 描述本地开发流程、测试策略及调试技巧 - 详细介绍生产环境部署、CI/CD 集成及云平台部署方案 - 增加监控、性能优化及故障排查的最佳实践 - 新建管理后台前端 Dockerfile 和对应 nginx 配置文件 - 新增项目快速启动的 README 指南，方便开发者快速上手		2026-02-13 19:13:23 +08:00
Backend	feat(marketing): 扩展营销码支持品类信息并完善通知机制	2026-02-13 19:00:06 +08:00
docs	feat: 实现完整的前后端功能	2026-02-11 21:36:37 +08:00
Frontend	chore(docs): 添加项目完整文档与快速启动指南	2026-02-13 19:13:23 +08:00
tests	feat(marketing): 扩展营销码支持品类信息并完善通知机制	2026-02-13 19:00:06 +08:00
vibe_images	feat: 实现完整的前后端功能	2026-02-11 21:36:37 +08:00
Demo.sln	chore(build): 添加基础构建配置和版本管理	2026-02-11 12:58:54 +08:00
deploy.ps1	chore(docs): 添加项目完整文档与快速启动指南	2026-02-13 19:13:23 +08:00
deploy.sh	chore(docs): 添加项目完整文档与快速启动指南	2026-02-13 19:13:23 +08:00
PROJECT_DOCUMENTATION.md	chore(docs): 添加项目完整文档与快速启动指南	2026-02-13 19:13:23 +08:00
README.md	chore(docs): 添加项目完整文档与快速启动指南	2026-02-13 19:13:23 +08:00

README.md

Fengling 项目快速开始指南

🚀 5分钟快速启动

1. 环境检查

确保已安装以下软件：

验证安装：

dotnet --version    # 应显示 10.0.xxx
node --version      # 应显示 18.x 或 20.x
docker --version    # 应显示 Docker 版本

2. 获取代码

git clone <your-repo-url>
cd Demo

3. 启动基础设施

# 启动 Redis 和其他依赖服务
cd Backend/scripts
docker-compose up -d

4. 启动后端服务

# 新终端窗口
cd Backend/src/Fengling.Backend.Web
dotnet run

后端将在 http://localhost:5511 启动

5. 启动前端

# 管理后台 - 新终端窗口
cd Frontend/Fengling.Backend.Admin
pnpm install
pnpm dev

# H5会员端 - 新终端窗口  
cd Frontend/Fengling.H5
pnpm install
pnpm dev

6. 访问应用

管理后台: http://localhost:3000
H5会员端: http://localhost:3001
API 文档: http://localhost:5511/swagger

📁 项目结构速览

Demo/
├── Backend/                 # 后端服务 (.NET 10)
│   ├── src/                # 源代码
│   ├── test/               # 测试代码
│   └── scripts/            # 基础设施脚本
├── Frontend/
│   ├── Fengling.Backend.Admin/  # 管理后台 (Vue 3)
│   └── Fengling.H5/             # H5会员端 (Vue 3)
├── docs/                   # 详细文档
└── PROJECT_DOCUMENTATION.md     # 完整文档

🔧 常用命令

后端开发

# 还原依赖
dotnet restore

# 构建项目
dotnet build

# 运行开发模式
dotnet watch run

# 运行测试
dotnet test

# 数据库迁移
dotnet ef database update

前端开发

# 安装依赖
pnpm install

# 启动开发服务器
pnpm dev

# 构建生产版本
pnpm build

# 代码检查
pnpm lint

基础设施管理

# 启动所有服务
docker-compose up -d

# 查看服务状态
docker-compose ps

# 停止服务
docker-compose down

# 完全清理
docker-compose down -v

🎯 开发约定

后端

使用 Clean Architecture 分层架构
遵循 DDD 领域驱动设计原则
API 使用 FastEndpoints 框架
数据验证使用 FluentValidation
使用 MediatR 处理命令查询

前端

使用 Composition API 风格
TypeScript 严格模式
Tailwind CSS 样式系统
Pinia 状态管理
Vue Router 路由管理

📚 学习资源

详细文档请查看: PROJECT_DOCUMENTATION.md

主要技术栈文档：

❓ 常见问题

Q: 后端启动失败，提示数据库连接错误？ A: 确保 Docker 服务已启动：docker-compose up -d

Q: 前端页面空白？ A: 检查控制台是否有错误，确认后端 API 是否正常运行

Q: 需要帮助？ A: 查看完整文档或联系项目维护者

Happy Coding! 🎉