main: 更新 README 文件,增加项目背景与使用指南

- 更新项目名称与简介,详细说明 ARS 的愿景与功能
- 描述 Demo 的功能组件和用户交互流程
- 添加源码目录说明,展示主要模块路径
- 提供快速启动指引,包括依赖安装和开发运行步骤
This commit is contained in:
2025-12-14 20:28:39 +08:00
parent b107a5e680
commit f435e6d571

View File

@@ -1,5 +1,29 @@
# Vue 3 + Vite
# ARS 前端 Demo
This template should help get you started developing with Vue 3 in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
本仓库是 **ARSAgent Runtime Server** 的无头后端默认前端。ARS 的愿景是为智能体提供“可治理、可观测、可组合”的运行时:解耦大模型与工具链,标准化会话/消息模型,让团队能安全、可审计地落地 Agent 能力。更多背景可参考博文https://blog.roog-code.cn/posts/roog-agent-handler/roog-agent-handler/
Learn more about IDE Support for Vue in the [Vue Docs Scaling up Guide](https://vuejs.org/guide/scaling-up/tooling.html#ide-support).
## 我们在解决什么
- **安全与治理**OPEN/LOCKED/CLOSED 状态门禁幂等键dedupe_key、权限与审计避免重复执行与越权调用。
- **可观测性**:会话 + 消息序列seq统一建模便于追踪、回放和问题定位。
- **可扩展性**:面向多模态(文本/文件/图片)与插件/工具调用,作为“无头”运行时嵌入业务。
- **落地效率**:默认 UI 与接口示例,让团队快速验证 Agent 能力并迭代。
## Demo 包含
- 登录/欢迎页:获取 JWT查看运行概览。
- 会话侧边栏ChatGPT 风格常驻列表,新建会话、分页“加载更多”、快速切换。
- 会话详情页(演示数据):历史消息、文件/图片附件展示,自适应输入区 + 附件槽。
- 用户管理:列表、编辑/新建、启用/禁用等后台常见操作。
## 目录速览
- 源码入口:`src/`
- 路由与页面:`src/router/index.js``src/views/*`
- 会话侧边栏:`src/components/SessionSidebar.vue`
- 会话详情 UI假数据演示`src/views/ChatView.vue`
- 测试:`tests/`Vitest + Vue Test Utils
## 快速开始
1. 安装依赖:`npm install`
2. 启动开发:`npm run dev`
3. 可选:配置后端基址 `VITE_API_BASE=http://localhost:8000/api`
默认对接 `ars-backend` 接口(接口文档见 `../ars-backend/docs`)。登录后可体验会话与用户管理流程;如需真实消息收发,请在 `ChatView` 中接入后端消息接口。***