asmbs/wp-schedule-builder

构建科学会议的互动议程

维护者

详细信息

github.com/asmbs/wp-schedule-builder

源代码

问题

安装: 474

依赖项: 0

建议者: 0

安全: 0

星级: 2

关注者: 5

分支: 0

开放问题: 7

类型：wordpress-plugin

5.0.4 2024-02-02 15:06 UTC

Requires

MIT a0266019e761d9e42e7672c16065dc8346d14ec0

  • Kyle Tucker <kyleatucker.woop@gmail.com>
  • Max McMahon <max.woop@asmbs.org>

This package is auto-updated.

Last update: 2024-08-31 00:31:11 UTC

README

ScheduleBuilder是一个用于构建科学会议互动议程的WordPress插件。

Latest Stable VersionLatest Unstable Version

要求

  • PHP 7.0+
  • 基于Composer的WordPress堆栈，如Bedrock
  • Node + NPM
  • Advanced Custom Fields (ACF) Pro WordPress插件v5.7+

安装

  1. 使用Composer安装

    composer require asmbs/wp-schedule-builder

  2. 激活插件。

  3. 转到新创建的日程设置页面，并添加您要管理的会议的日期、地点、房间和信用信息。

  4. 开始构建！

开发

要求

  • NPM
  • Composer

入门

要安装开发依赖项，请运行

composer install
npm install

要重新构建资源，请运行

npx webpack

(需要npx)

RESTful API

从v5.0版本开始，此插件包含一个仅提供GET的api。要启用此功能，请设置环境变量SCHEDULE_BUILDER_API为1。有关提供的端点的详细信息，请参阅Schedule-Builder API文档

Webhook

启用RESTful API后，可以通过设置环境变量SCHEDULE_BUILDER_WEBHOOK_URL为绝对URL来报告会议、摘要和人员帖子类型的变化。Webhook必须接受HTTP POST方法，并带有JSON正文

{
  "@type": "{post_type}",
  "@id": "{post_type}/{post_id}",
  "import_id": "{post_type}_{post_id}",
  "update": true|false,
  "status": publish|trash
}

其中{post_type}是session|abstract|person之一，而{post_id}是WordPress帖子ID

在向Webhook发送POST请求时，如果配置了环境变量SCHEDULE_BUILDER_WEBHOOK_AUTHORIZATION，其值将添加为请求的Authorization头中的Bearer令牌。

示例

应用程序.env文件

# .env
SCHEDULE_BUILDER_WEBHOOK_AUTHORIZATION=the_webhooks_authorization_token_value

将转换为HTTP授权头

Authorization: Bearer the_webhooks_authorization_token_value

查看API文档

一旦部署，要查看API文档，请导航到https://<meeting base url>/app/plugins/wp-schedule-builder/docs/，其中<meeting base url>是会议WordPress网站的FQDN。有关编译API文档的信息，请参阅docs/open-api.md