rwadurian/backend/services/reporting-service/docs/README.md

46 lines
1.1 KiB
Markdown

# Reporting Service 文档索引
## 概述
Reporting Service 是 RWA Durian 平台的报表与分析服务,负责生成、存储和导出各类业务报表。
## 文档目录
| 文档 | 描述 |
|------|------|
| [架构设计](./ARCHITECTURE.md) | 服务整体架构、DDD分层、六边形架构 |
| [API参考](./API.md) | RESTful API 接口详细说明 |
| [开发指南](./DEVELOPMENT.md) | 本地开发环境搭建、代码规范 |
| [测试指南](./TESTING.md) | 单元测试、集成测试、E2E测试说明 |
| [部署指南](./DEPLOYMENT.md) | 容器化部署、环境配置、CI/CD |
| [数据模型](./DATA-MODEL.md) | 数据库表结构、实体关系 |
## 快速开始
```bash
# 安装依赖
npm install
# 生成 Prisma Client
npx prisma generate
# 启动开发服务器
npm run start:dev
# 运行测试
npm test
```
## 技术栈
- **框架**: NestJS 10.x
- **语言**: TypeScript 5.x
- **数据库**: PostgreSQL 15 + Prisma ORM
- **缓存**: Redis 7
- **消息队列**: Kafka (可选)
- **导出格式**: Excel, CSV, PDF, JSON
## 联系方式
如有问题,请联系开发团队或提交 Issue。