# UniversalKit

**Repository Path**: template-warehouse/universal-kit

## Basic Information

- **Project Name**: UniversalKit
- **Description**: UniversalKit：一个多功能开源工具库，提供丰富的组件和API，支持跨平台开发，旨在简化开发流程，加速应用构建。
- **Primary Language**: JavaScript
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-05-10
- **Last Updated**: 2026-05-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# UniversalKit

#### 介绍
UniversalKit：一个多功能开源工具库，提供丰富的组件和 API，支持跨平台开发，旨在简化开发流程，加速应用构建。

本仓库按照不同技术栈划分子目录，便于快速定位与复用对应全家桶模板。

#### 软件架构

仓库采用「技术栈 + kit」的 kebab-case 命名规范，当前包含以下子目录：

| 目录 | 技术栈 | 说明 |
| --- | --- | --- |
| [html-ui](./html-ui) | 原生 HTML / CSS / JS | 静态 UI 组件与页面模板 |
| [vue2-kit](./vue2-kit) | Vue2 全家桶 | Vue2 + Vue Router + Vuex + Axios |
| [vue3-kit](./vue3-kit) | Vue3 全家桶 | Vue3 + Vue Router + Pinia + Axios |
| [vue3-ts-kit](./vue3-ts-kit) | Vue3 全家桶 + TypeScript | Vue3 + TS + Vue Router + Pinia + Axios |
| [react-kit](./react-kit) | React 全家桶 | React + React Router + Redux/Zustand + Axios |
| [react-ts-kit](./react-ts-kit) | React 全家桶 + TypeScript | React + TS + React Router + Redux/Zustand + Axios |
| [flutter-kit](./flutter-kit) | Flutter | Flutter 跨端项目模板 |
| [uniapp-kit](./uniapp-kit) | uni-app | 基于 uni-app 的多端统一开发模板 |

#### 目录结构

```
universal-kit/
├── html-ui/            # 原生 HTML UI 模板
├── vue2-kit/           # Vue2 全家桶项目
├── vue3-kit/           # Vue3 全家桶项目
├── vue3-ts-kit/        # Vue3 全家桶 + TypeScript 项目
├── react-kit/          # React 全家桶项目
├── react-ts-kit/       # React 全家桶 + TypeScript 项目
├── flutter-kit/        # Flutter 项目
└── uniapp-kit/         # uni-app 项目
```

完整目录结构及每个文件的作用说明见 [`docs/PROJECT_STRUCTURE.md`](./docs/PROJECT_STRUCTURE.md)。

代码注释规范（强制）见 [`docs/CODE_STYLE.md`](./docs/CODE_STYLE.md) —— 所有 JS/TS 方法使用 Forever丿顾北风格 JSDoc 块注释，方法内部使用 `//` 行注释。

#### 命名规范

- 统一采用小写 kebab-case（如 `vue3-ts-kit`）。
- 以技术栈名称开头，以 `-kit` 结尾，TypeScript 版本在技术栈与 `kit` 之间插入 `-ts`。
- 新增模板请沿用同一规范，避免使用驼峰或下划线命名。

#### 安装教程

1. 克隆仓库：`git clone <repo-url>`
2. 进入对应技术栈目录：`cd universal-kit/<子目录>`
3. 按各子目录内 README 指引安装依赖并启动

#### 使用说明

1. 根据项目类型选择对应子目录作为模板起点
2. 在子目录内独立维护依赖、构建与运行脚本
3. 公共资源（如静态 UI）可从 `html-ui` 中复用

#### 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

#### 提交规范

本仓库采用 [Conventional Commits](https://www.conventionalcommits.org/) 规范，已集成 **husky + commitlint** 自动校验。

首次克隆后执行：

```bash
npm install                                   # 自动启用 husky
git config commit.template .gitmessage        # 可选：注册提交模板
```

常用类型：

| Type     | 含义               | 示例                                   |
| -------- | ------------------ | -------------------------------------- |
| feat     | 新增功能           | `feat(vue3-kit): 新增用户登录页面`       |
| fix      | 修复 Bug          | `fix(html-ui): 修复导航栏错位`           |
| docs     | 文档改动           | `docs: 更新 README 命名规范`             |
| style    | 代码格式（不影响运行）| `style(html-ui): 统一缩进`               |
| refactor | 重构               | `refactor(react-kit): 拆分表单组件`      |
| perf     | 性能优化           | `perf(vue2-kit): 首屏由 3s 优化至 1.2s`  |
| test     | 测试               | `test(vue3-kit): 补充登录模块单测`        |
| build    | 构建系统 / 依赖     | `build(deps): 升级 vite 到 5.0`         |
| ci       | CI 配置            | `ci: 新增 PR 自动化工作流`             |
| chore    | 杂项维护           | `chore: 更新 .gitignore`                |
| revert   | 回滚提交           | `revert: 回滚 feat(vue3-kit): ...`      |

完整规范见 [`docs/COMMIT_CONVENTION.md`](./docs/COMMIT_CONVENTION.md)。