简介 • 功能特性 • 技术栈 • 快速开始 • 项目结构 • 开发指南 • 部署 • 许可证
--- ## 简介 NexFin 是一款面向国内期货个人投资者的 AI 智能体辅助决策平台，基于 [MaxKB](https://github.com/1Panel-dev/MaxKB) 源码深度定制开发。平台以微信小程序和 App 为载体，提供期货行情展示、AI 分析辅助、交易工具、投教服务、模拟交易、社区交流等核心功能。 ### 核心目标 - 打造合规的期货 AI 智能体辅助工具 - 降低期货投资学习门槛，提升决策效率 - 快速验证产品价值，支持用户规模扩展 - 基于 MaxKB 源码深度定制，完全掌控代码 - 构建期货投资者社区，提升用户粘性 - 创新智能人物系统，打造差异化竞争力 --- ## 功能特性 ### 核心模块 | 模块 | 优先级 | 功能描述 | |------|--------|---------| | **行情展示与管理** | P0 | 全品种期货行情展示、自选合约管理、K线图表、合约搜索 | | **AI 期货智能体** | P0 | 单品种走势分析、自然语言问答、策略参考生成 | | **期货辅助工具集** | P0 | 保证金计算器、盈亏计算器、行情预警工具 | | **模拟交易** | P1 | 虚拟账户管理、模拟下单、持仓管理、交易统计 | | **模拟交易大赛** | P1 | 大赛管理、参赛报名、排行榜、奖励发放 | | **智能人物** | P1 | 人物生成、人物进化、人物动画、人物互动 | | **论坛** | P1 | 板块管理、帖子发布、评论互动、内容审核 | | **教学功能** | P1 | 课程管理、学习进度、考试测评、证书系统 | | **资讯与投研** | P1 | 实时快讯、研报服务、基本面数据 | | **国际化与主题** | P1 | 中英文切换、主题定制、品牌定制 | | **后台管理** | P0 | 管理员管理、用户管理、内容管理、数据统计 | | **直播入口** | P2 | 多平台直播入口、直播预告、直播统计 | ### 产品亮点 - **AI 驱动**：基于 MaxKB 工作流引擎，支持多种大模型 - **实时行情**：通过 AkShare MCP 获取实时期货行情数据 - **智能人物**：个性化 AI 人物形象，随用户交易数据进化 - **模拟交易**：无风险练习环境，支持交易大赛 - **多端统一**：一次开发，支持微信小程序、iOS、Android、H5 --- ## 技术栈 ### 后端 | 技术 | 版本 | 说明 | |------|------|------| | Python | 3.11+ | 主要开发语言 | | Django | 4.x | Web 框架 | | PostgreSQL | 15.x | 主数据库 | | pgvector | 最新版 | 向量数据库扩展 | | Redis | 7.x | 缓存和会话管理 | | Celery | 最新版 | 异步任务队列 | | LangChain | 最新版 | LLM 应用框架 | ### 前端 | 技术 | 版本 | 说明 | |------|------|------| | Vue | 3.5+ | 前端框架 | | TypeScript | 5.8+ | 类型安全 | | Element Plus | 2.13+ | UI 组件库 | | Pinia | 3.0+ | 状态管理 | | Vue Router | 4.5+ | 路由管理 | | ECharts | 5.6+ | 图表库 | | LogicFlow | 1.2+ | 工作流编辑器 | | Vite | 6.2+ | 构建工具 | ### AI 与数据 | 技术 | 说明 | |------|------| | MaxKB | 开源智能体平台（基于 v2.8.0 二次开发） | | AkShare MCP | 期货数据源 MCP Server | | 通义千问 / OpenAI | 支持多种大模型 | --- ## 快速开始 ### 环境要求 - Python 3.11+ - Node.js 18+ - PostgreSQL 15+ - Redis 7+ ### 安装步骤 1. **克隆项目** ```bash git clone https://github.com/your-org/NexFin.git cd NexFin ``` 2. **后端配置** ```bash # 创建虚拟环境 python3.11 -m venv venv source venv/bin/activate # Linux/macOS # 或 venv\Scripts\activate # Windows # 安装依赖 pip install -r requirements.txt # 配置环境变量 cp .env.dev .env # 编辑 .env 文件，配置数据库、Redis 等 # 初始化数据库 python main.py upgrade_db # 创建超级管理员 python manage.py createsuperuser ``` 3. **前端配置** ```bash cd ui # 安装依赖 npm install # 开发模式启动 npm run dev ``` 4. **启动服务** ```bash # 启动后端服务（开发模式） python main.py dev web # 启动 Celery 任务队列 python main.py dev celery # 启动本地模型服务（可选） python main.py dev local_model ``` 5. **访问应用** - 前端管理界面：http://localhost:5173 - 后端 API：http://localhost:8080/api - 管理后台：http://localhost:8080/admin ### 生产环境启动 ```bash # 启动所有服务 python main.py start all -d # 仅启动 Web 服务 python main.py start web -d # 仅启动任务服务 python main.py start task -d ``` --- ## 项目结构 ``` NexFin/ ├── apps/ # Django 应用目录 │ ├── application/ # 应用管理模块 │ ├── chat/ # 聊天模块 │ ├── common/ # 公共模块 │ │ ├── auth/ # 认证相关 │ │ ├── cache/ # 缓存管理 │ │ ├── exception/ # 异常处理 │ │ ├── middleware/ # 中间件 │ │ └── utils/ # 工具函数 │ ├── folders/ # 文件夹管理 │ ├── knowledge/ # 知识库模块 │ ├── local_model/ # 本地模型 │ ├── maxkb/ # MaxKB 核心配置 │ │ ├── settings/ # Django 设置 │ │ ├── urls/ # URL 路由 │ │ └── wsgi/ # WSGI 配置 │ ├── models_provider/ # 模型提供商 │ ├── ops/ # 运维相关 │ │ └── celery/ # Celery 配置 │ ├── oss/ # 对象存储 │ ├── system_manage/ # 系统管理 │ ├── tools/ # 工具模块 │ ├── trigger/ # 触发器模块 │ └── users/ # 用户模块 ├── docs/ # 文档目录 │ ├── MaxKB源码分析与开发指南.md │ ├── 功能列表清单.md │ ├── 开发规划.md │ ├── 技术实现方案.md │ └── 需求文档.md ├── installer/ # 安装脚本 │ ├── Dockerfile │ ├── Dockerfile-base │ ├── init.sql │ └── start-*.sh ├── ui/ # 前端项目 │ ├── src/ │ │ ├── api/ # API 接口 │ │ ├── assets/ # 静态资源 │ │ ├── components/ # 组件 │ │ ├── directives/ # 指令 │ │ ├── enums/ # 枚举 │ │ ├── layout/ # 布局 │ │ ├── locales/ # 国际化 │ │ ├── permission/ # 权限 │ │ ├── request/ # 请求封装 │ │ ├── router/ # 路由 │ │ ├── stores/ # 状态管理 │ │ └── main.ts # 入口文件 │ ├── public/ # 公共资源 │ ├── package.json │ └── vite.config.ts ├── main.py # 主入口文件 ├── requirements.txt # Python 依赖 ├── .env.dev # 开发环境配置 └── LICENSE # 许可证 ``` --- ## 开发指南 ### API 接口规范 项目遵循 RESTful API 设计规范： | 方法 | 说明 | |------|------| | GET | 查询资源 | | POST | 创建资源 | | PUT | 完整更新资源 | | PATCH | 部分更新资源 | | DELETE | 删除资源 | ### 统一响应格式 ```json { "code": 0, "message": "操作成功", "data": {}, "timestamp": 1712812800000 } ``` ### 代码规范 - Python 代码遵循 PEP 8 规范 - 前端代码使用 ESLint + Prettier 格式化 - 提交信息遵循 Conventional Commits 规范 ### 运行测试 ```bash # 后端测试 python manage.py test # 前端测试 cd ui npm run test ``` ### 代码检查 ```bash # 后端代码检查 ruff check . # 前端代码检查 cd ui npm run lint npm run type-check ``` --- ## 部署 ### Docker 部署 ```bash # 构建镜像 docker build -t nexfin:latest -f installer/Dockerfile . # 运行容器 docker run -d \ --name nexfin \ -p 8080:8080 \ -e DATABASE_URL=postgresql://user:pass@host:5432/nexfin \ -e REDIS_URL=redis://host:6379/0 \ nexfin:latest ``` ### Docker Compose 部署 ```bash # 使用 docker-compose 启动 docker-compose up -d ``` ### 生产环境配置建议 | 服务 | 配置 | 数量 | 用途 | |------|------|------|------| | 应用服务器 | 4核8G | 3台 | 运行 MaxKB 应用 | | 数据库主库 | 8核16G | 1台 | PostgreSQL 主库 | | 数据库从库 | 4核8G | 1台 | PostgreSQL 从库 | | Redis 集群 | 4核8G | 3台 | Redis 集群 | | 负载均衡 | 2核4G | 2台 | Nginx + Keepalived | --- ## 合规要求 作为期货辅助决策工具，本平台严格遵守相关合规要求： - **风险提示**：所有 AI 分析结果强制附带风险提示语 - **禁止违规承诺**：严禁出现"保本"、"保收益"等违规表述 - **投资者适当性管理**：首次使用强制风险测评 - **内容合规审核**：AI 生成内容双重审核机制 - **数据合规**：严格遵守《个人信息保护法》 --- ## 贡献指南 我们欢迎所有形式的贡献！ 1. Fork 本仓库 2. 创建特性分支 (`git checkout -b feature/AmazingFeature`) 3. 提交更改 (`git commit -m 'Add some AmazingFeature'`) 4. 推送到分支 (`git push origin feature/AmazingFeature`) 5. 创建 Pull Request --- ## 许可证 本项目基于 [Apache 2.0](LICENSE) 许可证开源。 --- ## 致谢 - [MaxKB](https://github.com/1Panel-dev/MaxKB) - 开源智能体平台 - [AkShare](https://github.com/akfamily/akshare) - 开源金融数据接口 - [Vue.js](https://vuejs.org/) - 渐进式 JavaScript 框架 - [Django](https://www.djangoproject.com/) - Python Web 框架 ---Made with ❤️ by NexFin Team