- 抽取 ConsoleShell 共享外壳(Layout/Header/Sider/主题切换/侧边栏折叠) - Sidebar 纯化为接受 menuItems prop 的展示组件 - Admin 管理台:/ 总览 + /projects 项目管理 - Workbench 工作台:/workbench/:projectId 项目作用域 - WorkbenchProjectGate 入口守卫(loading/error/archived/不存在拦截) - ProjectContext 提供当前项目上下文 - 项目管理表格 active 行增加'进入工作台'按钮 - 项目名称 trim 后最多 10 字符(前后端一致) - Workbench 总览页展示项目 Descriptions - Header 区分:管理台显示副标题,工作台显示项目名 + 返回管理台按钮 - 28/28 前端测试通过 - 文档更新:frontend.md ConsoleShell 规范、usage.md 双入口说明
49 lines
1.8 KiB
Markdown
49 lines
1.8 KiB
Markdown
# 快速开始
|
||
|
||
本文档说明如何安装和配置 Alfred·阿福。
|
||
|
||
## 1. 安装依赖
|
||
|
||
```bash
|
||
bun install
|
||
```
|
||
|
||
## 2. 准备配置文件
|
||
|
||
```bash
|
||
cp config.example.yaml config.yaml
|
||
```
|
||
|
||
按需编辑 `config.yaml` 中的监听地址、日志、存储路径等配置。配置文件为启动时的必传参数。
|
||
|
||
## 3. 启动开发模式
|
||
|
||
```bash
|
||
bun run dev config.yaml
|
||
```
|
||
|
||
访问 http://127.0.0.1:5173 查看应用。
|
||
|
||
## 下一步
|
||
|
||
- [配置文件](config.md) — 了解 YAML 结构、变量语法和配置字段
|
||
- [部署文档](deploy.md) — 生产构建和运行方式
|
||
- [开发文档](../development/README.md) — 开发规范、架构和质量门禁
|
||
|
||
## 功能介绍
|
||
|
||
| 功能 | 路径 | 说明 |
|
||
| ---------- | ----------------------- | ---------------------------------------- |
|
||
| 总览 | `/` | Admin 管理台总览,展示运行时元信息 |
|
||
| 项目管理 | `/projects` | 创建、编辑、归档、恢复和永久删除项目 |
|
||
| 工作台总览 | `/workbench/:projectId` | Workbench 工作台总览,按项目维度查看信息 |
|
||
| 用户管理 | `/users` | 页面建设中 |
|
||
| 系统设置 | `/settings` | 页面建设中 |
|
||
|
||
平台提供两个入口:
|
||
|
||
- **Admin(管理台)**:全局管理视角,包含总览和项目管理。默认入口,访问 `/` 即可进入。
|
||
- **Workbench(工作台)**:项目维度视角,通过 `/workbench/:projectId` 进入指定项目的工作台。URL 可保存为浏览器书签,下次直接进入。仅 active 状态的项目可进入工作台,archived 项目不可访问。
|
||
|
||
从项目管理页面的 active 项目行可点击"进入工作台"跳转到对应项目的工作台。
|