lifespikes/php-beam

此软件包的最新版本(20220410084112)没有提供许可证信息。

为LifeSpikes项目提供的具有偏见的PHP引导包


README

lifespikes/lifespikes 的组件

标题已经说明了一切,不是吗?

Laravel 包,提供了一种简单的方式来部署由 Vite 和 React 驱动的 Inertia 应用程序。

入门指南

安装

使用 Composer 安装此软件包

composer require lifespikes/php-beam

您还需要安装相应的 Inertia、React 和 Vite 包。如果您使用 Foxy 这样的包管理器桥接器,我们已包括一个 package.json 文件,它会为您安装这些包。

尽管我们尽量保持一切尽可能通用,但如果您使用这些工具的旧版本,您可能无法使用我们的配置助手。

快速入门

LIVR 是一个具有偏见堆栈的包,但其他一切由您决定。配置 LIVR 有两个步骤

Laravel 配置

我们的服务提供程序围绕 innocenzi/laravel-viteinertiajs/inertia-laravel 展开。我们为这两个库提供了标准配置,应该支持大多数安装。您可以通过覆盖 config/php-beam.php 中找到的任何配置选项来配置 PhpBeam。

JS 配置

LIVR 随附一组 TypeScript 文件,您可以使用这些文件快速启动环境。

只需在项目根目录中创建一个 vite.config.ts 文件,并导入我们的配置助手

/* Running vite:tsconfig will provide you with a @php-beam/config alias */
import generateViteConfig from '@php-beam/config';

export default generateViteConfig({
  ...customViteConfig
})

我们的助手将为您生成配置。如果您需要添加任何自定义配置,您可以通过将配置作为第一个参数传递给助手来实现。

根视图、页面和引导

最后一步是提供 Inertia 应用的主要入口点和根视图。默认情况下,我们的配置将在 resources/js/App.tsx 中查找入口点,并使用其内置的根视图。

您可以在 php-beam 配置中指定这些来自定义它们

return [
    'entry_point' => 'resources/js/App.tsx',
    'root_view' => 'php-beam::app',
    
    // There are other options you can customize,
    // be sure to check the config/php-beam.php file
    // for more information.
];

用法

Inertia 入口点

我们试图使设置 Inertia 应用的入口点尽可能简单。一旦您指定了入口点 (或使用默认入口点),您就可以使用 createInertiaViteApp 助手来设置您的 Inertia 应用程序。

import createInertiaViteApp from '@php-beam/inertia';

createInertiaViteApp(
  import.meta.glob('./your-pages-dir/**/*.tsx')
);

如果您需要更自定义的设置,如设置自定义解析逻辑,您可以使用标准的 createInertiaApp 助手。但您仍然可以使用我们的 resolvePageComponent 助手进行模块解析!

环境配置

自定义 LIVR 配置的最佳方式是使用环境变量。直接修改配置值可能会影响 LIVR 如何与 vite 助手同步设置。

以下是可以用于自定义 LIVR 的 env 变量列表