README

Dna Recipe

包含一组有用的模块、一个入门主题以及silverstripe recipe-cms

需求

Silverstripe 4。查看3.0分支以支持silverstripe 3。

入门

注意：假设你已经设置了node并全局安装了gulp。如果没有，你应该先做这些事情

安装

要使用此配方启动项目，请使用终端运行（用你的项目名称替换your-project）

composer create-project dnadesign/basic-recipe ./your-project cd your-project
make setup

这将

• 为您复制一个草稿.env文件（您需要更新此文件）
• 安装前端依赖项并在theme-default/dist中创建构建主题
• 运行composer install（因为此任务同时作为为项目上的未来开发者快速设置的任务）
• 运行composer vendor-expose将资产链接到public
• 运行dev/build ?flush

配方选项

要将此配方添加到现有项目

(可选) composer require dnadesign/basic-recipe ./your-project

要将cms配方依赖项移动到自己的composer文件中以进行修改

(可选) composer update-recipe silverstripe/recipe-cms

有关配方及其使用的更多信息，请参阅此处： https://github.com/silverstripe/recipe-plugin

使用此配方

此代码包含一个makefile，以便快速访问常见任务。运行make list或make help以获取可用选项，或直接打开Makefile。

主题

Theme-default是一个入门主题，旨在用作开发的基础。请参阅主题README文件以获取特定于主题的文档

测试和部署

此配方包含从CodeShip到Silverstripe仪表板的部署管道设置。MakeFile中包含用于此目的的命令。

如果您不打算使用此管道，请从makefile中删除这些命令。请注意，默认情况下我们不提交构建资产，因此如果您有基于git的部署管道，您可能希望从.gitignore中删除theme-default/dist

先决条件

• 一个Codeship账户
• 一个SilverStripe仪表板项目，以及仪表板API密钥
• 一个Amazon S3存储桶

注意：您仍然可以使用Codeship而无需部署到平台。

设置

1. 在MakeFile中更新pipeline_project_name，以与Silverstripe仪表板中使用的项目名称相匹配。
2. Codeship：为此构建创建一个新的项目，并使用项目的git详细信息设置它（Codeship支持GitHub、GitLab和BitBucket存储库）

CodeShip：设置您的测试

Codeship > 您的项目 > 项目设置 > 测试

设置命令

1. 选择您的技术 > 选择php
2. 更新php版本以支持您的项目。例如：phpenv local 7.2
3. 调整您可能需要的任何其他设置（例如，您可以使用以下方式设置内存限制：echo "memory_limit = 512M" >> $HOME/.phpenv/versions/7.2/etc/php.ini）
4. 调用 make pipeline_setuptest 命令来设置项目实例以便在内部运行测试

配置测试管道

1. 创建测试管道
2. 调用 make pipeline_test 命令来运行项目中的所有测试

注意：如果最新的提交消息中包含 SKIP_CI，则可以跳过测试。例如：FIX: 通过更新 [SKIP_CI] 修复 response.js 的 bug

Codeship：部署设置

配置

在 项目设置 > 环境 下配置您的 Codeship 环境变量。您需要以下内容
AWS_DEFAULT_REGION - 从您的 s3 桶账户。例如：ap-southeast-2
AWS_ACCESS_KEY_ID - 从您的 s3 桶账户。
AWS_SECRET_ACCESS_KEY - 从您的 s3 桶账户。
DASHBOARD_TOKEN - 您可以在 Silverstripe 仪表板上的个人资料中找到它
DASHBOARD_USER - 这是您在仪表板上使用的电子邮件地址，而不是您的用户名

注意：如果您不在 CWP 或 Silverstripe 平台上托管，AWS 连接可能需要根据部署到其他环境进行调整。

部署

项目设置 > 部署

1. 添加新的部署管道，并选择部署分支
2. 选择“自定义脚本”
3. 调用 make pipeline_deploy。这将准备测试构建 - 删除不需要的文件，创建一个 tar 文件，并将其发送到 SilverStripe 仪表板以进行部署。

现在您应该能够推送至部署分支以触发部署