zoutapps/laravel-backpack-branding

为您的全新backpack安装提供易用的CLI品牌化工具

dev-master / 1.0.x-dev 2018-05-06 21:19 UTC

This package is auto-updated.

Last update: 2024-09-22 05:27:54 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

此包将轻松为您提供新laravel-backpack安装所需的所有默认值,您需要更改以进行后端品牌化。

安装

通过Composer

$ composer require zoutapps/laravel-backpack-branding

基本用法

只需在控制台中输入以下命令。

$ php artisan za:brand

这将询问您所有可以设置的值。

扩展用法

如果您不想在每次设置时输入它们,可以将全局默认值存储为json文件。
我们仍会询问任何可以在json文件中设置但未提供的值。
此外,您还可以定义我们目前不询问的值,并添加/替换它们。

要应用您的全局默认值,请使用

$ php artisan za:brand path/to/your/default.json

Json格式

  • env键下,您可以指定要添加/替换到您的.env文件中的值。
  • config对象包含应修改的配置文件键。我们目前仅支持backpack_base键,以指定应在您的config/backpack/base.php中替换的值。
  • 下面是copy数组,其中您定义了一个具有srcdest的对象数组。对于每个对象,src路径(相对于default.json)下的所有文件和文件夹都将复制到dest路径(相对于您的项目根目录)。
  • 最后是branding对象,它定义了Branding外观的值。

示例defaults.json文件

{
  "env": {
    "BACKPACK_LICENSE": "YOUR_BACKPACK_LICENCE_KEY",
    "BACKPACK_REGISTRATION_OPEN": false
  },
  "config": {
    "backpack_base": {
      "project_name": "Your Project Name",
      "logo_lg": "<b>Back</b>pack",
      "logo_mini": "<b>B</b>p",
      "developer_name": "Oliver Ziegler",
      "developer_link": "https://zoutapps.de",
      "show_powered_by": true,
      "skin": "skin-blue",
      "default_date_format": "d.m.Y",
      "default_datetime_format": "d.m.Y H:i",
      "route_prefix": "admin"
    }
  },
  "copy": [
    {
      "src": "public/vendor",
      "dest": "public/vendor"
    }
  ],
  "branding": {
    "asset": {
      "logo": "public/vendor/logo.png",
      "banner": "public/vendor/banner.png"
    },
    "url": "https://github/zoutapps",
    "developer": "Zout Apps"
  }
}

外观

我们提供了一个Branding外观,以便方便地访问一些品牌值。

当前实现的是

  • Branding::asset($key):将返回文件的资产URL(例如Branding::asset('logo')
  • Branding::link($content = null, $class = null, $target = null):将返回具有指定值或方便默认值的HTML <a>标签。
  • Branding::developer():返回指定的开发者名称
  • Branding::url():返回指定的URL

变更日志

有关最近更改的更多信息,请参阅CHANGELOG

贡献

有关详细信息,请参阅CONTRIBUTINGCODE_OF_CONDUCT

安全

如果您发现任何与安全相关的问题,请通过电子邮件oliver.ziegler@zoutapps.de与我们联系,而不是使用问题跟踪器。

鸣谢

许可证

MIT许可证(MIT)。有关更多信息,请参阅许可证文件