README

一个Laravel软件包，可以添加创建“展示”或查看包含项目“奖杯”卡片的能力。它还包括一个管理显示和奖杯的管理面板，只能由登录的Auth用户访问。适用于Laravel 5.4以上版本。

仍在开发中！

项目

路线图

安装

安装软件包

composer require brokerexchange/showcase

要包含资源，你有两种选择

在你的主样式表中导入 "vendor/brokerexchange/showcase/resources/assets/build/public"，这将作为你的应用编译样式的一部分包含样式。
运行 php artisan vendor:publish --tag=showcase-assets 并在 <head> 中链接到 /vendor/showcase/public.css。

如果你想要发布所有资源

php artisan vendor:publish --tag=showcase

如果你只想发布特定的部分

php artisan vendor:publish --tag=showcase-assets
php artisan vendor:publish --tag=showcase-config
php artisan vendor:publish --tag=showcase-views

TODO：完成此部分并修复问题，这样你就不必使用public/vendor了

安装软件包开发环境

git clone [the-url]
composer install
npm install

测试项目

要创建测试项目： bash build-test-project.sh

这也可以用于重新构建测试项目，如果你出了点问题。

如果你想使用不同的数据库，请将 build-test-project.sh 顶部的凭据更改为匹配你想要的凭据。

更新

要使用软件包更改更新测试项目： bash update-test-project.sh

这将还会导出composer的autoload并清除Laravel缓存和编译的视图。

你可以使用的标志

--migrations：运行数据库迁移
--rundev：在更新测试项目之前运行软件包的 npm run dev

认证

测试项目在构建过程中生成Auth。使用测试项目创建了一个默认用户

电子邮件： homestead@test.email
密码：secret

你需要这个来访问展示管理面板，因为它们默认由Auth中间件保护。这可以从配置文件中更改。

资源

要构建开发过程中的软件包JS和SCSS资源，只需在运行更新脚本时使用 --rundev 标志。它将负责编译你的资源并将它们移动到测试项目的正确位置。

你仍然需要按照软件包安装说明将展示样式表链接添加到测试项目的 head。

使用

展示设计得尽可能简单易用。

显示

在您的前端使用显示非常简单。首先，获取一个显示并将其传递到视图中

$display = \Showcase\Showcase::display('Sample Box'); // display($id) works as well!
...
return view('view.name', compact('display'));

要在视图中使用它，只需使用 @showcaseDisplay() 指令

@showcaseDisplay($display)

显示的模板将自动渲染。

奖杯

如果您查看默认的显示组件视图，您会注意到它们都调用 showcaseTrophy($trophy, $display)。此指令渲染一个奖杯组件视图，该视图渲染一个奖杯的组件视图（如果 force_trophy_default 设置为 true，则为显示的默认奖杯组件视图）。

显示和奖杯组件视图都可以自定义。

注意：目前没有“排序”功能，但您仍然可以通过从显示中分离/附加奖杯来对奖杯进行排序，这将把特定的奖杯放在排序顺序的最后。这仅用于alpha功能，1.0版本将提供正确的排序。

最终用户自定义

显示组件

安装包后，您可以使用 php artisan vendor:publish --tag=showcase 命令发布包资源。

修改现有视图

资源发布后，您可以在 resources/views/vendor/showcase 目录中找到它们。您可以修改任何包视图，包括管理面板。

添加自定义显示组件

如果您想添加自定义组件，只需在 resources/views/vendor/showcase/public/components 中创建一个新文件。然后，在创建或编辑显示时，您的自定义组件将显示在下拉选择中！

自定义CSS

只需将CSS目标指向Showcase选择器来自定义样式。要使自定义样式显示在管理面板中，请确保您在 resources/views/vendor/showcase/app/includes 中的 _stylesheets 包含中添加了一个链接标签到您的CSS。

配置

在配置文件 showcase.php 中为您公开了一些配置选项。

table_prefix 设置Showcase表使用的表前缀
middleware 设置Showcase路由通过的中介（以逗号分隔）
description_length 设置描述字段的字符限制
route_prefix 设置Showcase路由和命名路由使用的表前缀

表前缀

默认情况下，所有展示表都使用 showcase_ 作为前缀。您可以根据需要更改此前缀。

中介

默认情况下，所有Showcase管理路由都通过 web 和 auth。您可以在配置中更改此数组以添加或删除您想要的中介。

brokerexchange / showcase

维护者

详细信息