feat: add README.md for Kintone Helper Extension project

This commit is contained in:
2025-10-17 16:32:12 +08:00
parent 4b3f4e9c20
commit 1fbf3f564a

65
README.md Normal file
View File

@@ -0,0 +1,65 @@
# Kintone Helper Extension
这是一个 Chrome 扩展程序,用于增强 Cybozu Kintone 平台的功能。扩展程序通过添加字段标签等方式,提升在 Kintone 页面上的使用体验。
## 功能特性
- **添加字段标签**: 在 Kintone 的详情页面,和表单设置页面上添加 id 标签
- 正在开发中,目前在表单设置页面上,如果修改了就会出错
## 项目结构
```
src/
├── background.js # 后台服务工作进程
├── main.js # 主入口文件
├── features/
│ └── add-field-label/ # 添加字段标签特性
│ ├── dom.js # DOM 操作相关
│ ├── fields.js # 字段处理逻辑
│ ├── main.js # 特性主控制器
│ └── settings.js # 配置设置
├── page/
│ ├── admin/
│ │ └── form/
│ │ └── admin-field-label-processor.js # 管理员表单页面标签处理器
│ └── detail/
│ └── field-label-processor.js # 详情页面标签处理器
└── utils/
├── constants.js # 常量定义
├── dom-utils.js # DOM 工具函数
├── field-utils.js # 字段工具函数
└── kintone-utils.js # Kintone 平台相关工具
```
## 可以运行的命令
项目使用 npm 进行管理,以下是常见的命令:
- `npm install`: 安装项目依赖
- `npm run dev`: 启动开发服务器,用于开发时的热重载
- `npm run build`: 生产环境构建,将扩展打包为可分发的版本
- `npm run build:dev`: 开发环境构建,用于测试
- `npm run watch:build`: 监听文件变化并自动构建(开发时使用)
## 安装到 Chrome 扩展的流程
1. **构建扩展**:
```bash
npm run build
```
这将在 `dist` 目录下生成构建好的扩展文件。
2. **打开 Chrome 浏览器**,在地址栏输入 `chrome://extensions/` 并回车。
3. **启用开发者模式**:
在页面右上角启用"开发者模式"的开关。
4. **加载扩展**:
点击"加载已解压的扩展程序"按钮,选择项目根目录下的 `dist` 文件夹。
5. **验证安装**:
扩展将出现在扩展列表中,图标将显示在 Chrome 工具栏中。
6. **测试扩展**:
访问 Kintone 页面,检查字段标签是否正确显示。