kolesnikoff/contenta-jsonapi-project

基于 Docksal 本地环境的 contentacms/contenta-jsonapi-project 分支。

安装: 4

依赖者: 0

建议者: 0

安全: 0

星星: 0

关注者: 2

分支: 9

语言:CoffeeScript

类型:项目

dev-8.x-1.x 2018-02-27 14:08 UTC

This package is not auto-updated.

Last update: 2024-09-15 04:21:03 UTC


README

此存储库是使用 Circle CI 和 Pantheon 开始 Contenta 项目的一个示例。

此存储库的目标是展示如何轻松地安装一个现代工作流程来部署 Drupal 8 后端,以便为您的解耦站点提供服务。

关于 Contenta

Contenta 是 Drupal API 首选分发的社区努力。《Contenta》在加泰罗尼亚语中意为“快乐”,这指明了该项目的目标:“Contenta 关于内容,让您的内容快乐”。Contenta 项目旨在拥有几个可以与 Drupal 8 中所有蓬勃发展的解耦解决方案共享目标和资源的分发。这个特定的实例专注于 JSON API

通过安装 contenta 分发,您将获得一个空白的 Drupal 安装,您可以开始创建内容类型。但是,如果您只是测试分发,您可以安装 recipes_magazin 贡献模块,以获取一个丰富的内容模型和示例内容进行操作。

为了提供一致的经验,《Contenta》项目与 开箱即用体验倡议 保持一致。我们正在积极合作,提供相同的内容类型和默认内容,以便我们可以提供开箱即用的解耦结构化内容体验。

关于 JSON API

JSON API 是一个有偏见的现代规范,它允许在不经历典型的 REST 痛苦的情况下构建基于 REST 的数字体验。《Contenta {json:api}》基于 jsonapi 模块,允许根据规范与您的内容进行交互。

以下是一些有趣的文档资源

已知消费者

此演示存储库将仅公开一个 API,以构建数字体验。您将在下面的列表中找到如何为 Contenta 构建功能丰富消费者的示例。

We have no examples at the moment. We are working hard on it.

生成内容

生成器使用

cd cli
node generator-form.js node

此文件夹提供了一些生成器,可帮助您开始构建解耦 Drupal 站点。

  • generator-form:从给定的实体类型、包和表单模式生成一个工作的表单组件
  • generator-view:从给定的实体类型、包和视图模式生成一个工作的视图组件

它利用一些映射,将格式化器/小部件与定义在 form.mapping.jsonview.mapping.json 中的 React 组件进行映射。

使用方法

从 GitHub 分支或克隆此存储库,并添加您的 Circle CI 和 Pantheon.io 信息。

Circle CI 集成

待办事项

Pantheon 集成

待办事项

添加自定义代码

使用基于 Composer 的工作流程(需要链接到博客文章),您不需要在您的存储库中包含 Drupal 核心或贡献模块。Circle CI 将在部署到 Pantheon 之前为您下载所有依赖项。但是,您可能需要添加自定义代码以满足项目需求。

待办:解释添加自定义代码的推荐工作流程。