|
|
@@ -1,33 +1,88 @@
|
|
|
# minnan-collect-web
|
|
|
|
|
|
-This template should help get you started developing with Vue 3 in Vite.
|
|
|
+闽南文化非遗采集端。用于给传承人采集闽南文化非遗相关信息。
|
|
|
|
|
|
-## Recommended IDE Setup
|
|
|
+## 技术栈
|
|
|
|
|
|
-[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
|
|
|
+### 前端核心技术
|
|
|
|
|
|
-## Type Support for `.vue` Imports in TS
|
|
|
+- **框架**: Vue 3
|
|
|
+- **语言**: TypeScript
|
|
|
+- **构建工具**: Vite
|
|
|
+- **状态管理**: Pinia
|
|
|
+- **路由管理**: Vue Router
|
|
|
|
|
|
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
|
|
|
+### UI 组件库
|
|
|
|
|
|
-## Customize configuration
|
|
|
+- Ant Design Vue
|
|
|
+- Bootstrap
|
|
|
|
|
|
-See [Vite Configuration Reference](https://vite.dev/config/).
|
|
|
+### 富文本编辑器
|
|
|
|
|
|
-## Project Setup
|
|
|
+- TinyMCE
|
|
|
+
|
|
|
+### 地图
|
|
|
+
|
|
|
+- @vuemap/vue-amap (高德地图)
|
|
|
+
|
|
|
+### 工具库
|
|
|
+
|
|
|
+- @imengyu 系列库 (请求库、工具和组件)
|
|
|
+- nprogress (进度条)
|
|
|
+- vue-esign (电子签名)
|
|
|
+- vue-clipboard3 (剪贴板)
|
|
|
+- vue3-carousel (轮播图)
|
|
|
+
|
|
|
+## 项目结构目录组织
|
|
|
|
|
|
-```sh
|
|
|
-npm install
|
|
|
```
|
|
|
+src/
|
|
|
+├── api/ # API 接口定义
|
|
|
+├── assets/ # 静态资源
|
|
|
+│ ├── fonts/ # 字体文件
|
|
|
+│ ├── images/ # 图片资源
|
|
|
+│ └── scss/ # 样式文件
|
|
|
+├── common/ # 公共配置和工具
|
|
|
+│ ├── config/ # 配置文件
|
|
|
+│ └── upload/ # 上传相关
|
|
|
+├── components/ # 通用组件
|
|
|
+│ ├── content/ # 内容组件
|
|
|
+│ ├── controls/ # 控制组件
|
|
|
+│ ├── dynamicf/ # 动态表单组件
|
|
|
+│ ├── icons/ # 图标组件
|
|
|
+│ └── parts/ # 部分组件
|
|
|
+├── pages/ # 页面组件
|
|
|
+│ ├── admin/ # 管理页面
|
|
|
+│ ├── components/ # 页面组件
|
|
|
+│ └── forms/ # 表单页面
|
|
|
+├── router/ # 路由配置
|
|
|
+├── scripts/ # 脚本文件
|
|
|
+├── stores/ # Pinia 状态管理
|
|
|
+├── App.vue # 根组件
|
|
|
+└── main.ts # 入口文件
|
|
|
+```
|
|
|
+
|
|
|
+## 开发与构建
|
|
|
|
|
|
-### Compile and Hot-Reload for Development
|
|
|
+### 开发命令
|
|
|
|
|
|
-```sh
|
|
|
+```bash
|
|
|
+# 启动开发服务器
|
|
|
npm run dev
|
|
|
```
|
|
|
|
|
|
-### Type-Check, Compile and Minify for Production
|
|
|
+### 构建命令
|
|
|
|
|
|
-```sh
|
|
|
+```bash
|
|
|
+# 构建项目
|
|
|
npm run build
|
|
|
+# 构建项目然后打包并推送线上
|
|
|
+npm run updater update post web
|
|
|
+```
|
|
|
+
|
|
|
+### 类型检查
|
|
|
+
|
|
|
+```bash
|
|
|
+# 执行TypeScript类型检查
|
|
|
+npm run type-check
|
|
|
```
|
快乐的梦鱼