syntro/ssto

为 Syntro 项目提供的 SilverStripe 框架安装程序

安装: 88

依赖者: 0

建议者: 0

安全: 0

星标: 3

关注者: 2

分支: 1

开放问题: 3

语言:方案

类型:silverstripe-recipe


README

🎭 Tests Dependabot composer Packagist Version

Syntro Silverstripe SSTO(来自 Single-stage-to-orbit 的缩写)提供了一种从头开始创建新 Silverstripe 项目的预包装方案。特色包括

  • 基于 bootstrap 的样式
  • 基于 webpack 的构建工具
  • 带有一些标准块的 elemental 编辑器,帮助您开始

📯 开始

要开始,只需运行: (有关我们的 devenv 的更多信息,请参阅 ssdev。)

npx ssdev init -r syntro/ssto:^2 projectname

安装后,请参阅 清单,以使新创建的项目成为您自己的项目。然后,您应该用如何克隆新项目的指南替换本部分的 README。

🖥 Silverstripe 服务

要使用 docker 启动服务器,请运行

npx ssdev serve

这将启动一个主机和数据库容器,运行您的项目。要停止它,请运行

npx ssdev down

🎨 主题化

-> 请参阅 📖 主题化文档

🎭 测试

默认情况下,此方案提供了 PHPUnit、PHPCS 和 PHPStan 用于测试。您可以通过执行以下操作来运行测试

npx ssdev run -- vendor/bin/phpunit
npx ssdev run -- vendor/bin/phpstan analyse --memory-limit=1G -l4 -c phpstan.neon app/src/
npx ssdev run -- vendor/bin/phpcs app/
npx ssdev run -- vendor/bin/phpcbf app/

🆕 提交新事物

我们建议使用 Gitflow Workflow(适用于大型团队)或 Git Feature Branch Workflow(适用于小型团队)。当创建具有新功能的新的 PR 时,请使用“合并和合并”选项,并使用前缀(这有助于在 PR 标题中添加前缀)

  • add: 当添加新事物时
  • fix: 当修复某些内容时
  • change: 当更改某些内容时
  • deprecate: 当某些内容将被删除时
  • remove: 当某些内容被删除时
  • (Bump: 用于依赖项更新)

遵循此方法可简化发布并允许使用自动生成的更改日志。

🚀 发布

在您有一个可部署的应用程序/网站后,您可以将其部署到服务器。我们建议您按照以下步骤操作(这意外地还会触发生产部署作业)

  1. 确保所有测试通过
  2. 运行 npm run release --next="x.x.x"
  3. 将更改提交为 release/x.x.x 并推送它们
  4. 在 Github 上创建一个新版本 x.x.x

➕ 更多信息

请参阅以下内容获取更多信息