项目简介
此项目是一个基于 vite、vue3 和 TypeScript 的现代开发模板,旨在帮助开发者节省项目配置时间,结合主流插件构建现代开发架构,从而提升开发效率。该模板提供了一套开箱即用的开发环境,涵盖众多实用功能,可满足多种 web 应用开发场景的需求。
项目的主要特性和功能
- 构建与框架:采用 Vite 作为构建工具,使用 Vue3 前端框架,支持 TypeScript 静态类型语言。
- 路由与布局:具备文件路由系统,目录结构即路由;拥有布局系统,可设置默认和自定义布局。
- 模拟数据:支持 Mock 数据,方便在开发阶段进行接口测试。
- 自动引入:实现 Api、组件、图标自动引入,减少手动引入的繁琐。
- 实用工具:集成 VueUse 强大的 hooks 库;采用 Windi CSS 原子 CSS 库,支持暗黑模式。
- 请求管理:支持 SWR 请求方式,使用 pinia 进行状态管理。
- 包管理:推荐使用 pnpm 包管理器,具有更快、更节省空间等优点。
- 用户体验:具备跳转进度条,提供漂亮的 404 页面。
- 调试与测试:支持 Inspect 调试工具、Vitest 单元测试。
- 其他功能:支持 Markdown 渲染、路径别名
~
、命令行自动创建与删除、i18n 国际化、tsx、gzip 资源压缩、环境变量配置,同时提供统一的代码规范与风格。
安装使用步骤
前提条件
推荐使用 node 当前的长期维护版本 v16(大于 v16.13.1),该模板不限定特定的包管理器,npm、yarn 和 pnpm 均可,同时 npm 版本应尽量新,强烈推荐使用 pnpm(安装教程)。
操作步骤
- 复制模板
- Gitee:
git clone git@gitee.com:dishait/tov-template.git
- Gitee:
- 安装依赖
pnpm install
- 或
npm install
- 或
yarn
- 开发
- 常规开发:
pnpm dev
或npm run dev
或yarn dev
- 开启 host:
pnpm dev:host
或npm run dev:host
或yarn dev:host
- 自动打开浏览器:
pnpm dev:open
或npm run dev:open
或yarn dev:open
- 常规开发:
- 预览
- 常规预览:
pnpm preview
或npm run preview
或yarn preview
- 开启 host:
pnpm preview:host
或npm run preview:host
或yarn preview:host
- 自动打开浏览器:
pnpm preview:open
或npm run preview:open
或yarn preview:open
- 常规预览:
- 打包:
pnpm build
或npm run build
或yarn build
- 单元测试:
pnpm test
或npm run test
或yarn test
- 单元测试报告生成:
pnpm coverage
或npm run coverage
或yarn coverage
- 样式报告预览:
pnpm analysis
或npm run analysis
或yarn analysis
- 样式报告打包:
pnpm analysis:build
或npm run analysis:build
或yarn analysis:build
- 类型检查:
pnpm typecheck
或npm run typecheck
或yarn typecheck
- 自动创建:
pnpm auto:create
或npm run auto:create
或yarn auto:create
- 自动移除:
pnpm auto:remove
或npm run auto:remove
或yarn auto:remove
- 依赖更新
- 安全版本更新:
pnpm deps:fresh
或npm run deps:fresh
或yarn deps:fresh
- 主版本更新(可能有破坏性,谨慎使用):
pnpm deps:fresh:major
或npm run deps:fresh:major
或yarn deps:fresh:major
- 次版本更新(可能有破坏性,谨慎使用):
pnpm deps:fresh:minor
或npm run deps:fresh:minor
或yarn deps:fresh:minor
- 补丁版本更新:
pnpm deps:fresh:patch
或npm run deps:fresh:patch
或yarn deps:fresh:patch
执行以上命令后,需重新执行包安装命令,如pnpm i
或npm i
或yarn
- 安全版本更新:
- 代码规范校验
- 常规校验:
pnpm lint
或npm run lint
或yarn lint
- 校验时修复:
pnpm lint:fix
或npm run lint:fix
或yarn lint:fix
- 常规校验:
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】