Jpom/web-vue3/README.md
2023-09-11 22:01:16 +08:00

2.3 KiB
Raw Blame History

项目介绍

本项目采用 Vue3 + Vite + TypeScript + Antdv + Pinia构建。

项目采用Vue 3 <script setup> SFC写法请查看script setup docs了解更多信息。

构建运行

pnpm dev # 本地运行
pnpm build # 打包

参与贡献

环境准备

Node.js 和 pnpm

开发需要 Node.js 16+ 和 pnpm v8。

推荐使用 nvm 管理 Node.js避免权限问题的同时还能够随时切换当前使用的 Node.js 的版本。在 Windows 系统下的开发者可以使用 nvm-windows

推荐使用pnpm,节约内存。 在 pnpm官网选择一种方式安装即可。

编辑器

这边我们推荐使用 VSCode 我们我们尽量采用工具化方式来约束开发规范和编码风格, 使用VSCode即可应用现有配置和推荐你安装适合项目的插件。 具体配置看/.vscode 目录

⚠️因为我们在升级vue3的过程中vue2版本也在不断迭代 为了确保我们始终是在最新的代码基础上开发,编写某个页面前记得先从web-vue 目录中找到同名文件先替换下。

目录结构

.
├── .vscode
│   └── setting.json
├── dist
├── mock
│   └── app.tstsx
├── src
│   ├── components # 公共组件
│   ├── assets # 静态资源
│   ├── interface # 类型定义
│   ├── router # 路由配置
│   ├── stores # 状态管理器
│   │   └── index.ts
│   ├── pages # 页面
│   │   ├── login
│   │   └── user
│   ├── utils # 工具文件
│   │   └── index.ts
│   ├── api # 接口文件
│   │   └── api.ts
│   ├── app.vue
│   ├── main.ts
├── node_modules
├── .env
├── eslint.json
├── vite.config.ts // vite配置
├── package.json
├── tsconfig.json
└── type.d.ts