项目简介
这是一个基于Vite构建工具与一系列实用插件的项目管理系统。运用现代化前端框架和后端服务开发,旨在实现高效的代码组织、开发和部署流程,保障项目的稳定性和可扩展性。
项目的主要特性和功能
- 高效构建:借助Vite构建工具,实现快速的模块打包和加载,提升开发效率。
- 前端框架支持:支持React等现代化前端框架,提供良好用户体验。
- 后端服务集成:集成后端服务如API接口,实现前后端无缝对接。
- 插件化体系:提供丰富插件支持,满足项目定制化需求。
- 代码规范检查:集成ESLint、Stylelint等工具,确保代码质量和规范性。
- 接口管理:集成yapi接口管理工具,便于管理API接口信息。
- 模块化设计:采用模块化设计原则,使代码结构清晰,易于维护。
安装使用步骤
前提准备
确保系统已安装Node.js(版本 >= 16.14)和pnpm(版本 >= 3),并下载项目的源代码文件。
安装依赖包
打开终端,进入项目目录,执行以下命令安装项目依赖:
bash
pnpm i
pnpm run install
启动项目
执行以下命令启动项目:
bash
pnpm run dev
此时项目会启动开发服务器,可在浏览器中查看项目运行情况。
代码规范检查与格式化
为保证代码质量,可运行以下命令进行代码规范检查与格式化:
bash
pnpm run eslint # 检查代码规范问题
pnpm run prettier # 格式化代码风格问题
pnpm run stylelint # 检查样式规范问题
若检查发现错误或警告,请根据提示修复。提交代码前,需确保代码符合项目规范。
开发配置
Vite配置
项目使用Vite作为构建工具,可在根目录下的vite.config.ts
文件中修改配置,如配置代理服务器。.env.development
和.env.production
文件用于设置环境变量,如API地址和资源路径。
CSS模块化规范
采用国际通用规范recommended - scss,使用Stylelint对scss代码自动校验纠错。组件根样式命名为“功能 - 模块名”,组件内只能使用class,样式采用单根形式。
提交规范
采用特定的提交规范,格式为<type>(<scope>): <subject>
。type
有feat、fix等7个标识;scope
说明commit的影响范围;subject
是简短描述,不超50字符,以动词开头,首字母小写,结尾无句号。
yapi - to - typescript使用
修改ytt.config.ts
中的token切换工程,执行pnpm ytt
生成src/api
里的文件。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】