38 lines
2.0 KiB
Markdown
38 lines
2.0 KiB
Markdown
# 项目入口文档（admin-system）
|
||
|
||
本仓库为管理后台前端模块（Vue3 + Vite + Element Plus）。整体项目文档位于 docs 目录，根 README 作为入口说明与索引。
|
||
|
||
## 一、环境与约定
|
||
- Node >= 16，pnpm >= 8.6（统一使用 pnpm）
|
||
- 锁文件：仅保留 pnpm-lock.yaml（已删除 package-lock.json）
|
||
- 代码规范：ESLint + Prettier + Stylelint
|
||
|
||
## 二、快速开始
|
||
```bash
|
||
pnpm i
|
||
pnpm dev # 本地开发
|
||
pnpm build:prod # 生产构建
|
||
pnpm preview # 构建后预览
|
||
```
|
||
|
||
## 三、项目结构（总体规划）
|
||
- docs 文档目录（本项目文档均位于此目录）
|
||
- admin-system 管理后台目录（当前仓库）
|
||
- mini-program 小程序 app 目录（规划）
|
||
- backend 后端服务目录（规划）
|
||
- website 官网目录（规划）
|
||
- scripts 脚本目录（规划：数据库/部署/测试/运维脚本）
|
||
|
||
备注：当前仓库仅包含“管理后台前端”；其余模块与目录按整体项目规划在对应仓库或后续子模块中维护。
|
||
|
||
## 四、文档索引
|
||
- 需求文档：docs/整个项目需求文档.md、docs/官网需求文档.md、docs/后端管理需求文档.md、docs/管理后台需求文档.md、docs/小程序app需求文档.md
|
||
- 架构文档：docs/整个项目的架构文档.md、docs/后端架构文档.md、docs/小程序架构文档.md、docs/管理后台架构文档.md
|
||
- 详细设计：docs/数据库设计文档.md、docs/管理后台接口设计文档.md、docs/小程序app接口设计文档.md
|
||
- 开发文档：docs/后端开发文档.md、docs/小程序app开发文档.md、docs/管理后台开发文档.md、docs/后端管理开发文档.md
|
||
- 其他文档：docs/测试文档.md、docs/部署文档.md、docs/运维文档.md、docs/安全文档.md、docs/用户手册文档.md
|
||
|
||
## 五、注意事项
|
||
- 文档统一使用 Markdown 与 Mermaid，图片资源不再随代码仓库分发；如需图片请使用 SVG 或外链。
|
||
- 如需新增模块或脚本，请在 docs 中更新对应文档并在此索引登记。
|