项目简介
本项目是一个基于Vite、Vue3和TypeScript的开箱即用现代开发模板。该模板集成了众多实用的功能与特性,旨在帮助开发者节省项目配置时间,以更现代的方式开发Web应用,提高开发效率。
项目的主要特性和功能
- 构建与框架:采用Vite作为构建工具,结合Vue3框架与TypeScript类型系统,提供高效的开发与构建体验及类型检查。
- 路由与布局:支持文件路由,目录结构即路由;具备布局系统,可自定义或使用默认布局。
- 数据模拟与请求:提供Mock支持,可模拟后端API数据;支持SWR请求方式,实现数据预取和增量更新。
- 自动引入:支持Api、组件、图标自动引入,减少手动导入的繁琐。
- 实用工具与状态管理:集成VueUse实用库,使用pinia进行状态管理。
- 样式与主题:采用Windi CSS,支持暗黑模式,提供原子CSS和排版插件。
- 调试与测试:有Inspect调试支持,提供项目依赖图谱;支持Vitest单元测试及测试报告生成。
- 其他特性:支持Markdown渲染、i18n国际化、tsx语法、gzip资源压缩、环境变量配置;具备跳转进度条、漂亮的404页;提供命令行自动创建与删除功能;统一代码规范与风格,生产环境自动移除开发日志,支持defineOptions。
安装使用步骤
假设用户已经下载了本项目的源码文件,可按以下步骤操作:
1. 安装依赖:不限定包管理器,可使用pnpm install
或npm install
或yarn
。强烈推荐使用pnpm
,若未安装,可参考安装教程。
2. 开发
- 常规开发: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
。
3. 预览
- 常规预览: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
。
4. 打包:使用pnpm build
或npm run build
或yarn build
。
5. 单元测试:使用pnpm test
或npm run test
或yarn test
。
6. 单元测试报告生成:使用pnpm coverage
或npm run coverage
或yarn coverage
。
7. 样式报告预览:使用pnpm analysis
或npm run analysis
或yarn analysis
。
8. 样式报告打包:使用pnpm analysis:build
或npm run analysis:build
或yarn analysis:build
。
9. 类型检查:使用pnpm typecheck
或npm run typecheck
或yarn typecheck
。
10. 自动创建:使用pnpm auto:create
或npm run auto:create
或yarn auto:create
。
11. 自动移除:使用pnpm auto:remove
或npm run auto:remove
或yarn auto:remove
。
12. 依赖更新
- 安全版本更新: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
。
上述依赖更新命令仅对package.json
写入,需重新执行包安装命令,如pnpm i
或npm i
或yarn
。
13. 代码规范校验
- 校验:pnpm lint
或npm run lint
或yarn lint
。
- 校验并修复:pnpm lint:fix
或npm run lint:fix
或yarn lint:fix
。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】