项目简介
本项目是基于uni-app框架的项目模板,采用vite作为构建工具、vue3作为前端框架、typescript作为编程语言。模板集成多种开发工具与功能模块,能提高开发效率和代码质量,适用于快速启动uni-app项目。
项目的主要特性和功能
主要特性
- 支持uni-app cli模式,便于后期进行CI/CD集成。
- 可自动导入Vue API,减少手动导入操作。
- 具备Typescript + Eslint + Prettier配置,提供官方代码规范。
- 有Git提交代码校验,确保代码提交规范性。
- 提供路由拦截功能,增强页面访问控制。
- 支持Pinia状态持久化。
- 已引入uview-plus组件库,方便UI开发。
- 有基于uni.request封装的易用HTTP请求库。
- 具备基于uni官方API封装的WebSocket库。
功能模块
通用模块
- 可在
components/registerGlobComp
中手动注册全局组件。 - 有别名功能,简化文件路径引用,如
/@/xxxx => /src/xxxx
。 - HTTP请求库功能强大,支持多种配置和自定义设置。
- 可通过环境变量存储项目参数,通过
utils/env -> getEnv()
获取。
特殊文件夹含义
enums
:存放Typescript枚举值。logics
:存放与业务和框架耦合的全局逻辑代码。settings
:用于运行时的参数设置。utils
:存放通用工具代码,可独立用于其他项目。hooks
:存放Vue3 Hooks,便于组件开发复用逻辑代码。
安装使用步骤
安装步骤
- 从代码仓库下载项目源码文件。
- 使用
npm
或yarn
安装项目所需依赖。 - 根据项目需求配置相应的环境变量文件(如
.env
、.env.development
、.env.production
等)。 - 在VSCode中打开项目,安装工作区推荐的插件。
- 根据需要配置
ts
、eslint
、prettier
等开发工具的相关设置。 - 启动本地开发服务器或构建生产环境。
注意事项
- 多人开发时遵循代码规范,不私自修改禁止修改的文件,如
.vscode
、ts
、eslint
等配置文件。 - 使用推荐的格式化工具,遵循项目命名规范。
- 使用路由时,在
router/routes
中配置页面。 - 使用HTTP请求库时,遵循配置优先级规则,确保请求正确。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】