gtht-miniapp-sdk

<h1 align="center">GTHT Miniapp SDK</h1> <p align="center">gtht-miniapp-sdk 是一套基于 Uniapp + Vue3 框架开发的兼容多端的 UI 组件库。</p> <p align="center"> 国内：📖 <a href="https://vojh.gtja.com/gtht-miniapp-sdk-docs">文档</a>     🧑🏻‍🏫 <a href="https://vojh.gtja.com/gtht-miniapp-sdk-docs/mobile/">案例演示</a>     </p> --- ## 介绍 `gtht-miniapp-sdk` 是一套基于 `Uniapp` + `Vue3`框架开发的兼容多端的 `UI` 组件库。 `gtht-miniapp-sdk` 兼容 H5 / 小程序 / `APP`（不支持 `nvue` 或 `uvue`）。 ## 特性 - 🧩 96+个高质量组件，覆盖移动端主流场景 - 💪 支持一套代码同时开发 H5 / 小程序 / App - 🌿 支持按需引入和 `Tree Shaking` - 📖 详尽的文档和案例展示 - ʦ 使用 `TypeScript` 编写，提供完整的类型定义 - 🌈 支持定制主题 - 🌍 国际化支持 - 🌙 支持暗黑模式 - 🧪 单元测试覆盖率超过 80%，保障稳定性 - ⭐️ 零外部依赖，不依赖三方 npm 包 ## 开源协议本项目基于 [MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89) 协议，请自由地享受和参与开源。 ## 更新日志 <a href="https://pingcode.gtht.com.cn/wiki/spaces/DZSW/pages/h7u53Kb_">更新日志</a> ## 如何维护 ### 前提条件 - 确保 node >= 20 - 建议使用 pnpm 包管理器 - 建议使用 vscode 编辑器 ### 克隆仓库到本地 ```bash git clone https://github.com/sutras/gtht-miniapp-sdk.git ``` ### 安装依赖 ```bash npm install ``` ### 运行开发环境 ```bash npm run dev ``` 运行上面命令后会生成四个链接： ```bash Local: http://localhost:5173/gtht-miniapp-sdk-docs/mobile/ （演示） Network: http://192.168.1.121:5173/gtht-miniapp-sdk-docs/mobile/ (局域网演示） Local: http://localhost:7761/gtht-miniapp-sdk-docs/ （文档） Network: http://192.168.1.121:7761/gtht-miniapp-sdk-docs/ （局域网文档） ``` ### 测试 ```bash npm run test ``` ### 构建文档站点 ```bash npm run build:site ``` ### 预览构建的文档站点 ```bash npm run preview ``` ### 构建组件库 ```bash npm run build ``` ### 发布组件库到 npm ```bash npm run release ``` ## 修复问题流程 - 修复问题 - 测试 `npm run test` - 修改版本号 - 暂存 `git add .` - 提交 `git commit -m 'fix: '` - 给提交打标签 `npm run tag` - 修改更新日志 `https://pingcode.gtht.com.cn/wiki/spaces/DZSW/pages/h7u53Kb_` - 打包组件库 `npm run build` - 发布到 npm `npm run release` - 使用 HBuilderX 发布到 uniapp 插件市场 - 打包文档（如果文档有修改）`npm run build:site` - 部署文档 ## 新增组件流程 - 运行 `npm run nc` 命令创建组件 - 运行 `npm run nsc` 命令创建子组件 - 编写组件代码 - 编写案例代码 - 编写组件文档 - 编写测试用例 - 使用实际项目本地安装测试 `pnpm link ../gtht-miniapp-sdk` - 从上面的“修复问题流程”第三个步骤“修改版本号”开始走一遍