README

这是 Voyager 前端的持续长期分支

此 Laravel 扩展包向 Voyager 项目添加前端视图、路由和资源。

它包含前端布局（例如，页眉、页脚等）的基本结构和使用 Foundation 框架的主题资源。

由 Pivotal Agency 构建。

先决条件

• PHP >= 7.1.3
• Node & NPM
• Composer
• Laravel 需求

安装

1. 安装 Laravel + Voyager (替换 $VARs 为您自己的值)

# 1.0 Install Laravel
composer create-project --prefer-dist laravel/laravel $DIR_NAME

# 1.1 Require Voyager
cd $DIR_NAME && composer require tcg/voyager

# 1.2 Copy .env.example to .env and update the DB & App URL config
cp .env.example .env

# 1.3 Generate a Laravel key
php artisan key:generate

# 1.4 Run the Voyager Installer
php artisan voyager:install

# 1.5 Create a Voyager Admin User
php artisan voyager:admin $YOUR_EMAIL --create

2. 安装 Voyager 前端

# 2.0 Require this Package in your fresh Laravel/Voyager project
composer require pvtl/voyager-frontend

# 2.1 Run the Installer
composer dump-autoload && php artisan voyager-frontend:install

# 2.3 Build the front-end theme assets
npm run dev

# 2.4 Set the Laravel search driver in your .env
echo "SCOUT_DRIVER=tntsearch" >> .env

有任何问题？请参阅下面的故障排除部分。

'Got Cron'？

这是一个提醒，在您的服务器上设置标准的 Laravel cron。Voyager 前端包有几个计划任务，因此依赖于 cron 运行。

* * * * * php /path-to-your-project/artisan schedule:run >> /dev/null 2>&1

主题开发

SCSS & JS

当您准备好开始为前端样式化时，您可以在更新 SCSS 和/或 JS 文件后使用以下命令

覆盖视图

假设您想更新前端页眉的布局

1. 创建目录 resources/views/vendor/voyager-frontend
   • 您放入此处的任何文件都将替换随此包提供的默认视图
2. 从 vendor/pvtl/voyager-frontend/resources/views/ (在这种情况下，是 partials/header.blade.php) 复制相应的文件到匹配的文件结构并更新

所以现在您将有

    /resources
        /views
            /vendor
                /voyager-frontend
                    /partials
                        /header.blade.php

对 header.blade.php 所做的任何更改都将自动反映在网站上。

缩略图/图像缩放

此包包含一个自动图像缩放功能。当您在前端 blade 模板中引用图像时，只需调用类似以下内容

{{ imageUrl($pathToImage, $width, $height, $config = ['crop' => false, 'quality' => 100] ) ?: '/default.png' }}

<!-- For example for a 300px wide thumbnail scaled down (i.e. no cropping) -->
<img src="{{ imageUrl($blockData->image, 300, null, ['crop' => false]) ?: '/default.png' }}" />

<!-- Or a 200px by 100px cropped thumbnail -->
<img src="{{ imageUrl($blockData->image, 200, 100) ?: '/default.png' }}" />

"CDN" 您的图像

该函数将输出一个绝对 URL，其中主机名将是 APP_URL - 但是您可以在 .env 文件中添加一个 ASSET_URL 变量来使用不同的主机名。

搜索

生成索引

此模块包含一个计划任务，用于重新生成索引，一旦您为 Laravel 设置了作业，它将自动运行。如果您需要测试和重新生成搜索索引，可以手动运行命令 php artisan voyager-frontend:generate-search-indices。

配置搜索（使用 Laravel Scout）

默认情况下，此模块在您在 .env 文件中定义以下变量后，会自动包含对“页面”和“文章”模型的“搜索” - 查看 Laravel Scout 文档

SCOUT_DRIVER=tntsearch

但是，您可以通过将“Searchable”特质附加到它们来扩展并定义您自己的“Searchable”模型，以便包含在搜索结果中。

class Page extends Model
{
    use Searchable;

    public $asYouType = false;

    /**
     * Get the indexed data array for the model.
     * @return array
     */
    public function toSearchableArray()
    {
        $array = $this->toArray();

        // customise the searchable array
        
        return $array
    }
}

然后您将能够挂钩到搜索配置并使用配置密钥 合并 您的“Searchable”模型（最好使用 Service Provider）：scout.tntsearch.searchableModels。

$this->mergeConfigFrom(self::PACKAGE_DIR . 'path/to/config/scout.php', 'scout.tntsearch.searchableModels');

您的配置文件应包含类似于此模块 scout.php 配置的值

<?php

return [
    '\My\Searchable\Models\Namespace',
];

测试

您可以通过切换到包目录并运行composer脚本测试Pvtl/Test包。

  cd packages/pivotal/test;
  composer run test

故障排除

错误：找不到类 VoyagerFrontendDatabaseSeeder

只需再次运行 php artisan voyager-frontend:install

错误：命令 "npm i ..." 执行失败。

运行 npm install 然后再次尝试 php artisan voyager-frontend:install