wbcodes/laravel-core

本站核心控制台命令包

1.0.3 2022-09-30 06:11 UTC

This package is not auto-updated.

Last update: 2024-09-28 13:58:12 UTC


README

这是 Wbcodes Core 项目的仓库。一个用于在 Laravel 项目中简单使用 CRM 的 Wbcodes 站点包。

文档

所有文档均可在 Wiki 页面 上找到。我们鼓励您阅读它。如果您是新手,请从 安装指南 开始。要更新包,请参考 更新指南

要求

当前包的要求如下

  • Laravel >= 7.x
  • PHP >= 7.3

安装

要安装我们的包,您可以按照以下步骤进行。

注意:以下步骤适用于全新安装程序,如果您正在更新包,请参阅 更新 部分。

  1. 在您的 Laravel 项目根目录下,使用 composer 安装包

    composer require wbcodes/laravel-core
    
  2. (仅适用于 Laravel 7+) 如果您想安装身份验证脚手架,则可以使用 composer 安装 laravel/ui

    composer require laravel/ui
    php artisan ui vue --auth
    

    注意:建议阅读 Laravel 身份验证文档 了解有关身份验证脚手架的详细信息。

  3. 使用以下命令安装所需的包表

    php artisan notifications:table          
    php artisan queue:failed-table           
    php artisan queue:table                  
    php artisan session:table    
    
  4. 从 imtilak/laravel-core 包发布供应商文件

    php artisan vendor:publish --provider="Wbcodes\Core\Providers\SiteCoreServiceProvider"
    

    或者您可以使用 --tag={name} 提取所需的文件

    php artisan vendor:publish --provider="Wbcodes\Core\Providers\SiteCoreServiceProvider" --tag=migrations
    php artisan vendor:publish --provider="Wbcodes\Core\Providers\SiteCoreServiceProvider" --tag=seeders
    php artisan vendor:publish --provider="Wbcodes\Core\Providers\SiteCoreServiceProvider" --tag=factories
    php artisan vendor:publish --provider="Wbcodes\Core\Providers\SiteCoreServiceProvider" --tag=public
    php artisan vendor:publish --provider="Wbcodes\Core\Providers\SiteCoreServiceProvider" --tag=lang
    php artisan vendor:publish --provider="Wbcodes\Core\Providers\SiteCoreServiceProvider" --tag=helpers
    php artisan vendor:publish --provider="Wbcodes\Core\Providers\SiteCoreServiceProvider" --tag=controllers
    php artisan vendor:publish --provider="Wbcodes\Core\Providers\SiteCoreServiceProvider" --tag=views
    
  5. 将以下代码添加到 ./routes/web.php 文件中

    Auth::routes(['register' => false, 'verify' => true]);
    
  6. 创建数据库并添加数据库配置到 .env 文件中

       DB_DATABASE ='your_db_name'
       DB_USERNAME ='username'
       DB_PASSWORD ='password'
  7. 然后您应该运行以下命令来运行迁移

    > php artisan migrate --seed
    

    或者您可以使用以下命令

     > php artisan migrate
     > php artisan db:seed
    

    您可以使用以下命令刷新数据库

     > php artisan migrate:refresh
    

    或者您可以使用以下命令刷新数据库

     > php artisan migrate:fresh
    

最后,使用以下命令安装所需的包资源

php artisan sitecore:install

您可以使用 --force 选项覆盖现有文件。

您可以使用 --interactive 选项通过过程并选择您想要安装的内容进行指导。

将此中间件添加到 Http/Kernel.php 中的 $routeMiddleware

'wbcodes_settings'        => \Wbcodes\Core\Middleware\SiteSettingsMiddleware::class,
'wbcodes_verified_device' => \Wbcodes\Core\Middleware\VerifyDevice::class,

将 SiteUserTrait 中间件添加到 Http/Kernel.php 中的 $routeMiddleware

<?php

   namespace App\Models;
   
   use Wbcodes\Core\Traits\SiteUserTrait;
   
   class User extends Authenticatable
   {
         use CoreUserTrait;
   }

更新

  1. 首先,使用以下 composer 命令更新包

    composer update wbcodes/laravel-core
    
  2. 然后,更新所需的 Wbcodes Site 资源

    注意:如果您正在使用 Laravel 5.x 的 Wbcodes Site 并升级到 Laravel 6 版本,首先请删除您的 public/vendor 目录中的 Wbcodes Site 文件夹。

    为了发布新的 Wbcodes Site 资产,执行以下命令

    php artisan sitecore:update
    
  3. 如果您已发布并修改了此包提供的默认 master.blade.php 文件或其他任何视图,则可能需要更新它们。请注意,这些视图可能进行了大量更新,因此强烈建议您在更新之前备份您的文件。要更新视图,您可以按照以下步骤操作

    • 复制(或备份)您已修改的视图,那些在文件夹 resources/views/vendor/wbcodes/laravel-core 内的视图。

    • 使用 --force 选项发布新的视图集,以覆盖现有文件。

      php artisan sitecore:install --only=views --force
      
    • 将新安装的视图与您的备份文件进行比较,并重新对那些视图进行之前所做的修改。

  4. 偶尔会添加新的配置选项或更改默认值,因此建议在需要时验证和更新包配置文件。

    • 请复制(或备份)当前的包配置文件,即 config/site_core.php 文件。

    • 现在,发布新的包配置文件并接受覆盖警告(或使用 --force 选项以避免警告)。

      php artisan sitecore:install --only=config
      
    • 与备份配置文件进行比较,并重新进行之前所做的修改。

  5. 可能会添加或修改新的辅助函数,因此建议在需要时验证和更新包辅助文件。要更新辅助函数,可以按照以下步骤操作:

    • 请复制(或备份)当前的包辅助文件,即 config/site_core.php 文件。

    • 现在,发布新的包辅助文件并接受覆盖警告(或使用 --force 选项以避免警告)。

      php artisan sitecore:install --only=helpers
      
    • 与备份配置文件进行比较,并重新进行之前所做的修改。

Artisan 命令行工具

本包提供了一些 artisan 命令以管理其资源。这些命令在下一节中解释。首先,我们将简要介绍可用的资源,它们由一个键名区分

> php artisan sitecore:clear

> php artisan sitecore:create:list-option

> php artisan sitecore:module:create

> php artisan sitecore:remove:reports-drafts

> php artisan sitecore:update:permissions

> php artisan sitecore:sync

php artisan sitecore:clear 命令将清除所有这些(视图、缓存、配置、路由)。

php artisan sitecore:create:list-option 命令将创建新的列表选项。

php artisan sitecore:module:create 命令将向模块表添加新行。

php artisan sitecore:remove:reports-drafts 命令将删除所有未保存的草稿报告。

php artisan sitecore:update:permissions 命令将更新所有权限,删除不再使用的权限并创建之前不存在的所需权限。

php artisan sitecore:sync .

鸣谢