docs: 按当前实现刷新 README / HANDOFF / ADMIN-PLAN
README: - 快速开始补上 stash-ui 必须先构建(file: 依赖),目录结构补 stash-ui 与新的前端目录 - 登录与设置改写为新的后台结构(左侧导航 + 页头/侧边栏/内容卡片子项)、明暗主题与 /interface - 前端路由补 /interface、/admin 与 /c/ 前缀;服务端回落说明改成 SPA_PREFIXES + SPA_PAGES - 表结构:node 增补 allow_groups / enabled,section_block 章节改为 card / card_group, 说明 user_version=22 与自动迁移 - HTTP API:内容目录改为 /api/catalog2,新增「其它接口」汇总表(与 /interface 页一致) - 已知限制:删掉「没有迁移」「没有身份认证」「只有 /c/** 一个前缀」等过时结论 HANDOFF.md 顶部加历史快照说明与变更摘要;ADMIN-PLAN.md 的待办标注已完成项; stash-web/README.md 从 Vite 模板换成真实说明
This commit is contained in:
+25
-28
@@ -1,32 +1,29 @@
|
||||
# React + TypeScript + Vite
|
||||
# stash-web
|
||||
|
||||
This template provides a minimal setup to get React working in Vite with HMR and some Oxlint rules.
|
||||
Stash 的前端控制台:React 19 + Vite + TypeScript。组件与样式全部来自
|
||||
[`@stash/ui`](../stash-ui)(`file:` 依赖,需要先在同级目录构建出它的 `dist`)。
|
||||
|
||||
Currently, two official plugins are available:
|
||||
|
||||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Oxc](https://oxc.rs)
|
||||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/)
|
||||
|
||||
## React Compiler
|
||||
|
||||
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
|
||||
|
||||
## Expanding the Oxlint configuration
|
||||
|
||||
If you are developing a production application, we recommend enabling type-aware lint rules by installing `oxlint-tsgolint` and editing `.oxlintrc.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"$schema": "./node_modules/oxlint/configuration_schema.json",
|
||||
"plugins": ["react", "typescript", "oxc"],
|
||||
"options": {
|
||||
"typeAware": true
|
||||
},
|
||||
"rules": {
|
||||
"react/rules-of-hooks": "error",
|
||||
"react/only-export-components": ["warn", { "allowConstantExport": true }]
|
||||
}
|
||||
}
|
||||
```bash
|
||||
npm install
|
||||
npm run dev # http://127.0.0.1:5173,/api 代理到后端 8080
|
||||
npm run build # 产物到 dist,随后会被 cargo build 内嵌进二进制
|
||||
npm run lint # oxlint
|
||||
```
|
||||
|
||||
See the [Oxlint rules documentation](https://oxc.rs/docs/guide/usage/linter/rules) for the full list of rules and categories.
|
||||
## 目录
|
||||
|
||||
| 路径 | 内容 |
|
||||
| --- | --- |
|
||||
| `src/AppNext.tsx` | 前台外壳:路由、卡片、侧栏、搜索、主题应用 |
|
||||
| `src/components/admin/` | 后台(`AdminNext.tsx`:左侧导航 + 分组 / 数据 / 首页 / 资料 / 系统面板) |
|
||||
| `src/components/api/` | `/interface` 接口一览页 |
|
||||
| `src/components/header/`、`sidebar/` | 页头(品牌、滚动信息、操作图标)与侧栏卡片 |
|
||||
| `src/components/content/` | 卡片、网格、详情视图 |
|
||||
| `src/data/view.ts`、`src/useViewRoute.ts` | 地址 ↔ 视图的路由规则(与服务端 `SPA_PREFIXES` / `SPA_PAGES` 对应) |
|
||||
| `src/theme.ts` | 明暗主题:本机偏好(localStorage)优先于站点默认 |
|
||||
|
||||
## 约定
|
||||
|
||||
- 页面里不写死颜色 / 字号 / 间距,一律用 `@stash/ui` 的 `--su-*` 令牌;
|
||||
- 站内跳转走 `navigate()`,不要用 `<a href>` 触发整页刷新;需要「新标签打开」时保留 `href` 并放行修饰键点击;
|
||||
- 组件库里没有的东西优先补进 `stash-ui`,而不是在这里再手写一遍(后台已经是 100% 由库组件组装)。
|
||||
|
||||
Reference in New Issue
Block a user