nova-kit/nova-on-vapor

Nova on Vapor Integration Library

v2.0.0 2024-12-14 04:07 UTC

Requires

• php: ^8.1
• composer-runtime-api: ^2.2
• illuminate/support: ^10.48.23 || ^11.35
• laravel/vapor-core: ^2.37
• nova-kit/nova-queued-export-as-csv: ^2.1
• symfony/polyfill-php83: ^1.31

Requires (Dev)

• larastan/larastan: ^2.4
• laravel/nova: ^5.0
• laravel/nova-devtool: ^1.0.1
• laravel/pint: ^1.17
• league/flysystem-aws-s3-v3: ^1.0 || ^3.0
• orchestra/pest-plugin-testbench: ^2.0
• orchestra/testbench: ^8.21 || ^9.0

Conflicts

• laravel/nova: <5.0.0 || >=6.0.0

MIT

• Mior Muhammad Zaki

README

This library attempts to solves several limitations when using Laravel Nova on Laravel Vapor including:

• Unable to use interactive mode on Artisan affecting nova:user command.
• Ability to use VaporFile and VaporImage locally via Minio.
• ExportAsCsv supports for Laravel Vapor

Installation

To install through composer, run the following command from terminal:

composer require "nova-kit/nova-on-vapor"

Usages

New nova:vapor-user Command

The command swaps interactive mode questions to artisan command options, so you can use --email, --name and optionally --password, as an example:

php artisan nova:vapor-user --name="Administrator" --email="[e-mail]"

Note: Without passing --password, the code would generate a random 8 character password and you can use the Forgot Password feature to reset the value.

Warning: Using --password is possible but be aware that the value will be logged to CloudWatch.

Minio for VaporFile and VaporImage locally

You can setup Minio locally and use it as a replacement for S3 locally. First you need to install league/flysystem-aws-s3-v3 by running the following command:

composer require "league/flysystem-aws-s3-v3"

Next, you need to enable and configure Minio:

NOVA_ON_VAPOR_ENABLES_MINIO=(true)

MINIO_USERNAME=
MINIO_PASSWORD=
MINIO_ENDPOINT=

AWS_ACCESS_KEY_ID="${MINIO_USERNAME}"
AWS_SECRET_ACCESS_KEY="${MINIO_PASSWORD}"
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=local
AWS_ENDPOINT="${MINIO_ENDPOINT}"
AWS_USE_PATH_STYLE_ENDPOINT=(true)

CSV Export

You can replace Laravel\Nova\Actions\ExportAsCsv with NovaKit\NovaOnVapor\Actions\VaporExportAsCsv:

use Laravel\Nova\Actions\ExportAsCsv;
use NovaKit\NovaOnVapor\Actions\VaporExportAsCsv;

/**
 * Get the actions available for the resource.
 *
 * @param  \Laravel\Nova\Http\Requests\NovaRequest  $request
 * @return array
 */
public function actions(NovaRequest $request)
{
    return [
        VaporExportAsCsv::make(),
    ];
}

If you would like to change the storage disk to store the CSV file that is available for download, you may invoke the withStorageDisk() method when registering the action:

return [
    VaporExportAsCsv::make()->withStorageDisk('s3'),
];

downloadViaTemporaryUrl Mixin

Laravel Vapor has a response limit of 6MB and this would cause issue when you need to download large files. You can avoid this by utilising Storage::temporaryUrl() to download the file:

VaporFile::make('Filename')->downloadViaTemporaryUrl(),