rootlyhq/rootly-zendesk

# Rootly Zendesk App ## 快速入门 ### 依赖项 - [Node.js](https://nodejs.org/en/) >= 24.0.0 - [Yarn](https://yarnpkg.com/) 4.x - [Zendesk CLI](https://github.com/zendesk/zcli)（用于本地开发和部署） 如果您使用 [mise](https://mise.jdx.dev/)，版本信息已固定在 `mise.toml` 中。 ### 设置 1. 克隆或复刻此代码库 2. 运行 `yarn install` ### 本地运行 要通过 `?zcli_apps=true` 将应用提供给您的 Zendesk 实例，请打开一个新终端并运行 ``` yarn run watch ``` 然后打开一个新终端并运行 ``` zcli apps:server dist ``` ## 文件夹结构 | 名称 | 描述 | |:----------------------------------------|:---------------------------------------------------------------------------------------------| | [`dist/`](#dist) | webpack 打包应用构建版本的文件夹 | | [`spec/`](#spec) | 所有测试文件存放的文件夹 | | [`src/`](#src) | 所有源 JavaScript、CSS、模板和翻译文件存放的文件夹 | | [`webpack/`](#webpack) | 用于在应用中支持 i18n 的 translations-loader 和 translations-plugin | #### dist dist 目录是在您运行应用构建脚本时创建的。在向 Zendesk Apps Marketplace 提交应用时，您需要打包此文件夹。这也是您在使用 [ZCLI](https://developer.zendesk.com/documentation/apps/app-developer-guide/zcli/) 时必须提供的文件夹。它包含应用的 manifest.json 文件，以及一个包含所有已编译的 JavaScript、CSS、HTML 和图片的 assets 文件夹。 #### spec spec 目录是存放所有测试文件和测试辅助工具的地方。 #### src src 目录是存放原始源代码的地方。它包含用于存放 JavaScript、样式表、模板、图片和翻译文件的目录。 #### webpack 此目录包含在构建时处理翻译的自定义工具： - translations-loader.js 将 .json 翻译文件转换为应用所需的 JavaScript 对象。 - translations-plugin.js 从 en.json 中提取强制性翻译字符串，用于 Zendesk Apps Marketplace 元数据。 ## I18n `/src/javascripts/lib/i18n.js` 中的 I18n 模块提供了一个 `t` 方法，用于根据键值查找翻译。有关更多信息，请参阅[使用 I18n 模块](https://github.com/zendesk/app_scaffolds/blob/master/packages/react/doc/i18n.md)。 ## 参数和设置 如果您需要使用 `dist/manifest.json` 中的 `parameters` 部分测试您的应用，请在根目录下创建一个 `settings.yml` 文件，并填入您的参数名称和测试值。例如： ``` apiKey: 'your-rootly-api-key' apiUrl: 'https://api.rootly.com/v1' ``` ## 测试 测试使用带有 jsdom 的 [Jest](https://jestjs.io/)。要运行测试： ``` yarn test ``` 测试文件位于 `spec` 目录下。 ## 部署 要检查您的应用是否能通过服务器端验证，请运行 ``` zcli apps:validate dist ``` 如果验证成功，您可以通过运行以下命令将应用上传到您的 Zendesk 账户 ``` zcli apps:create dist ``` 要在您的账户中创建应用后进行更新，请运行 ``` zcli apps:update dist ``` 或者，要创建一个 zip 压缩包以供手动上传，请运行 ``` zcli apps:package dist ``` 有关 Zendesk CLI 的更多信息，请参阅[文档](https://developer.zendesk.com/documentation/apps/app-developer-guide/zcli/)。 ## 实用链接 - https://developer.zendesk.com/ - https://developer.zendesk.com/documentation/apps/build-an-app/using-react-in-a-support-app/

标签：GNU通用公共许可证, MITM代理, Node.js, Rootly, Zendesk, 事件管理, 响应拦截, 工单系统, 数据可视化, 网络研究, 自定义脚本, 集成应用