sylius / plugin-template
Sylius 插件模板
v0.3.0
2023-06-19 09:30 UTC
Requires
- php: ^8.0
- symfony/console: ^5.4
- symfony/filesystem: ^5.4
- symfony/finder: ^5.4
- symfony/framework-bundle: ^5.4
- symfony/runtime: ^5.4
- symfony/yaml: ^5.4
Requires (Dev)
- phpunit/phpunit: ^9.5
README
section:readme
注意! Sylius 模板插件处于 alpha 阶段。请注意,在创建项目时可能会出现一些错误。
这个仓库受到了 spatie/package-skeleton-laravel 的极大启发。
插件模板
用于启动 Sylius 插件的模板。
要求
- 基于 *nix 的操作系统(macOS,Linux,WSL2)
- make
- PHP 版本 8.0 或更高
- Node.js 版本 16 或更高
如果您想快速开始,建议安装 Symfony CLI。它将帮助您使用我们的 Make 命令在本地运行项目。
使用方法
此仓库可用于构建 Sylius 插件。按照以下步骤开始
- 运行
composer create-project sylius/plugin-template ProjectName
- 享受创建您的包的过程。
- 如果您需要创建插件的帮助,请考虑阅读我们的 插件开发 指南。
或者您也可以使用 GitHub 上的 "使用此模板" 按钮,根据此模板创建一个新的仓库。之后您可以克隆您新创建的仓库并运行 make configure
来设置您全新的插件。
</section:readme>
:plugin_name
这里应该放您的描述。请限制在一到两段话。可以考虑添加一个小例子。
安装
-
运行
composer require :vendor_name_slug/:plugin_name_slug
。 -
导入路由
# config/routes/sylius_shop.yaml :config_key_shop: resource: "@:plugin_class/config/shop_routing.yaml" prefix: /{_locale} requirements: _locale: ^[A-Za-z]{2,4}(_([A-Za-z]{4}|[0-9]{3}))?(_([A-Za-z]{2}|[0-9]{3}))?$ # config/routes/sylius_admin.yaml :config_key_admin: resource: "@:plugin_class/config/admin_routing.yml" prefix: /admin
-
导入配置
# config/packages/_sylius.yaml imports: # ... - { resource: "@:plugin_class/config/config.yaml" }
-
应用迁移
bin/console doctrine:migrations:migrate
变更日志
请参阅 CHANGELOG 了解最近更改的详细信息。
贡献
请参阅 CONTRIBUTING 了解详细信息。
安全漏洞
请查阅 我们的安全策略 了解如何报告安全漏洞。
致谢
许可
请参阅 许可文件 了解有关许可的更多信息。