README

HM Juicer

与Juicer API集成，用于社交动态，并允许以可访问的方式展示社交媒体内容。

安装

使用Git

步骤 1

在您的目标目录中（无论是 wp-content/plugins 还是 wp-content/mu-plugins）使用 cd 进入并本地克隆仓库。

git clone git@github.com:humanmade/hm-juicer.git

使用Composer

通过 composer 安装插件。

composer require humanmade/hm-juicer

供应商包作为WordPress插件安装，需要从插件页面手动激活（或如果作为 mu-plugin 安装，则显式加载）。

两者：配置环境

您可能需要定义环境变量来定义您的Juicer账户、您的站点名称和URL。所有这些都是可选的，但如果其中任何一个未定义，则将在您的管理员的设置页面中显示一个页面来定义这些设置。

步骤 1

通过 JUICER_ID 常量将Juicer源名称添加到 wp-config.php 文件中。

define( 'JUICER_ID', 'myaccountname' );

这是用于您的Juicer源URL中的ID，例如 https://www.juicer.io/feeds/myaccountname。

步骤 2

定义您的站点名称。这将影响Juicer源中链接的显示方式。

define( 'JUICER_SITE_NAME', 'My Cool Site' );

步骤 3

添加Juicer长URL和短URL。这用于确定从您的站点发出的链接。

注意：虽然短URL旨在用于自定义URL或类似bit.ly这样的服务，但这可以是任何链接回您站点的URL。

define( 'JUICER_SHORT_URL', 'short.url' );
define( 'JUICER_LONG_URL', 'mydomain.com' );

两者：安装依赖项

如果您打算使用Juicer插件进行开发，则需要安装一些依赖项。目前，如果您没有定义上面的常量，这也需要这样做。为此，请进入目录并运行设置命令。

npm run setup

用法

要将Juicer源添加到页面，只需在模板中使用具有正确显示帖子数（和可选地，要显示的页面）的 juicer_feed 函数即可。有关 juicer_feed 函数的文档可在 inc/README.md 文件中找到。

致谢

由Human Made创建，通过Juicer API渲染和显示可访问的社交媒体动态。

由Chris Reynolds 维护。

贡献者

• Joeleen Kennedy
• Rian Rietveld

此插件依赖于这些库/技术，由一些优秀的开发者提供

• CMB2/CMB2
• humanmade/webpack-helpers
• humanmade/asset-loader
• Babel
• ESLint
• Webpack
• Sass

贡献

如果您想做出贡献，您需要设置您的本地环境。我们已经提供了一个简单的设置脚本，用于安装所有NPM依赖项以及任何所需的Composer依赖项。只需在检出仓库并 cd 进入后运行以下命令即可

npm run setup

为了在本地运行单元测试，您需要确保您安装了本地版本的PHP和MySQL/MariaDB（或在虚拟机/Docker容器内运行）。如果您的机器满足要求，您可以运行以下命令在您的环境中设置单元测试

npm run setup:tests

（这不是正常设置脚本的一部分，因为不是每个环境都支持它。）

开发流程遵循标准Human Made开发流程。

以下是一个简要概述

• 将您正在处理的任务分配给自己。
• 每个任务使用一个分支进行开发，例如 功能名。请每个特性/错误使用一个分支。
• 尽早提交PR以便跟踪进度。
• 完成开发后，通过标记“需要评审”来标记PR以供评审。
• 请人评审您的代码，并将任务分配给他们；如果附近没有人，项目负责人可以评审。

由Human Made用❤️制作