docs: 更新README文档添加服务端口信息并精简内容
- 添加各服务的端口配置信息 - 移除过时的gRPC和RabbitMQ说明 - 删除贡献规范章节以保持文档简洁
This commit is contained in:
parent
75e10f5324
commit
eec2da5343
24
README.md
24
README.md
@ -3,14 +3,16 @@
|
|||||||
面向个人投资者的智能选股分析系统,采用微服务架构构建。
|
面向个人投资者的智能选股分析系统,采用微服务架构构建。
|
||||||
|
|
||||||
## 服务一览
|
## 服务一览
|
||||||
- data-service:提供 A 股 / 美股行情数据(Python)
|
|
||||||
- quant-service:量化因子计算服务(Python)
|
各服务端口信息如下:
|
||||||
- emotion-service:情绪分析服务(Python)
|
- data-service:提供 A 股 / 美股行情数据(Python),端口:8000
|
||||||
- recommend-service:融合推荐服务(C#)
|
- quant-service:量化因子计算服务(Python),端口:8001
|
||||||
- user-service:用户管理服务(C#)
|
- emotion-service:情绪分析服务(Python),端口:8002
|
||||||
- frontend:前端交互界面(Vue.js)
|
- recommend-service:融合推荐服务(C#),端口:8003
|
||||||
- gitea-webhook:监听 Gitea Webhook 进行持续部署
|
- user-service:用户管理服务(C#),端口:8004
|
||||||
- traefik:作为统一网关实现服务发现和路由
|
- frontend:前端交互界面(Vue.js),端口:80
|
||||||
|
- gitea-webhook:监听 Gitea Webhook 进行持续部署,未在 docker-compose.yml 中明确端口
|
||||||
|
- traefik:作为统一网关实现服务发现和路由,主入口端口:80,Dashboard 端口:8080
|
||||||
|
|
||||||
## 使用方式
|
## 使用方式
|
||||||
```bash
|
```bash
|
||||||
@ -23,12 +25,10 @@ docker compose up --build
|
|||||||
**核心组件**:
|
**核心组件**:
|
||||||
- 服务发现:Consul
|
- 服务发现:Consul
|
||||||
- API网关:Traefik with Let's Encrypt
|
- API网关:Traefik with Let's Encrypt
|
||||||
- 消息队列:RabbitMQ
|
|
||||||
- 数据存储:PostgreSQL + Redis
|
- 数据存储:PostgreSQL + Redis
|
||||||
|
|
||||||
**通信协议**:
|
**通信协议**:
|
||||||
- RESTful API(80% 服务)
|
- RESTful API(80% 服务)
|
||||||
- gRPC(quant-service 与 data-service)
|
|
||||||
|
|
||||||
## 🔧 环境变量
|
## 🔧 环境变量
|
||||||
```env
|
```env
|
||||||
@ -49,10 +49,6 @@ uvicorn app:app --reload
|
|||||||
dotnet run
|
dotnet run
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🤝 贡献规范
|
|
||||||
1. 分支命名:feat/xxx, fix/xxx
|
|
||||||
2. 提交信息遵循 Conventional Commits
|
|
||||||
3. 提交 PR 前需通过 SonarQube 检测
|
|
||||||
|
|
||||||
## 📄 许可
|
## 📄 许可
|
||||||
[MIT](LICENSE)
|
[MIT](LICENSE)
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user