AriStockAI/README.md
fanfpy 806e444297 feat: 添加aktools服务并更新架构文档
- 在data-service中添加aktools依赖和运行配置
- 更新Traefik配置添加压缩中间件
- 修改Consul配置启用ACL
- 更新README添加架构图和开发指南
- 添加架构图文档
2025-06-21 22:53:09 +08:00

61 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# AriStockAI
面向个人投资者的智能选股分析系统,采用微服务架构构建。
## 服务一览
- data-service提供 A 股 / 美股行情数据Python
- quant-service量化因子计算服务Python
- emotion-service情绪分析服务Python
- recommend-service融合推荐服务C#
- user-service用户管理服务C#
- frontend前端交互界面Vue.js
- gitea-webhook监听 Gitea Webhook 进行持续部署
- traefik作为统一网关实现服务发现和路由
## 使用方式
```bash
docker compose up --build
```
## 📦 技术架构
![架构图](docs/architecture.svg)
**核心组件**
- 服务发现Consul
- API网关Traefik with Let's Encrypt
- 消息队列RabbitMQ
- 数据存储PostgreSQL + Redis
**通信协议**
- RESTful API80% 服务)
- gRPCquant-service 与 data-service
## 🔧 环境变量
```env
CONSUL_HTTP_ADDR=consul:8500
ALPHAVANTAGE_API_KEY=your_key
```
## 📚 API 文档
访问统一入口:`http://localhost/docs`
## 🛠 开发指南
```bash
# Python 服务
pip install -r requirements.txt
uvicorn app:app --reload
# C# 服务
dotnet run
```
## 🤝 贡献规范
1. 分支命名feat/xxx, fix/xxx
2. 提交信息遵循 Conventional Commits
3. 提交 PR 前需通过 SonarQube 检测
## 📄 许可
[MIT](LICENSE)
访问入口:`http://localhost` 或你的服务器域名(如 AriStockAI.com