Skip to content

Latest commit

 

History

History
197 lines (140 loc) · 8.45 KB

README.md

File metadata and controls

197 lines (140 loc) · 8.45 KB
Raw

Nova File Manager

Status License PHP Laravel Nova Latest Version on Packagist Total Downloads Downloads Run tests codecov

A file manager tool and field for Laravel Nova. Beautifully designed, and customizable, this tool will provide a plug'n'play solution for your file management needs.

Features :

⚡️ Blazing fast
📦️ Laravel Nova 4 compatible
💅 Built with Tailwindcss 3, Vue 3 and Pinia
🪨 Rock solid codebase built with Typescript
💽 Multi disk and filesystem support
🧩 Supports chunk and resumable uploads
🔧 Various customization and configuration options
🔍 A performant local search feature with Spotlight
🤹‍ Can save multiple assets from the same field
🔐 Access control and authorization gates
✂️ Built-in crop tool and image editor
📇 Built-in PDF viewer
🗂️ Drag and drop upload, with entire folder upload support
🗃️ Supports unzipping files
🚩 Onboarding tour for new users

Table of Contents

Getting Started

Prerequisites

This package requires the following :

  • PHP 8.0 or higher
  • Laravel Nova 4

Note If you plan on using this package with an S3 bucket, be mindful to follow the instructions for setting up an S3 storage disk.

Installing

To get started, you will need to install the following dependencies :

composer require oneduo/nova-file-manager

That's it, you're ready to go!

Configuration

You may publish the package's configuration by running the following command :

php artisan vendor:publish --tag="nova-file-manager-config"

Note You can find details about the configuration options in the configuration file section.

Usage

To get yourself started, you need to add the following tool to your NovaServiceProvider.php

// NovaServiceProvider.php

use Oneduo\NovaFileManager\NovaFileManager;

class NovaServiceProvider extends NovaApplicationServiceProvider
{
    // ...

    public function tools(): array
    {
        return [
            // ... any other tools
            NovaFileManager::make(),
        ];
    }
}

Now that the tool is registered, if you go back to your Nova dashboard, you should see a new navigation entry labeled " File Manager".

Once you've added the tool, you can start using it.

Go ahead and add a FileManager field to your Nova resource.

// app/Nova/User.php

use Oneduo\NovaFileManager\FileManager;

class User extends Resource
{
    // ...

    public function fields(NovaRequest $request): array
    {
        return [
            // ... any other fields
            FileManager::make(__('Avatar'), 'avatar'),
        ];
    }
}

You have now successfully added a File Manager field to your resource.

Configuration file

Key Description Type Default Notes
default_disk The default disk used by the package string public The default disk must be defined in your filesystems.php config
available_disks Provides a list of available disks to be used by the package string[] -
show_hidden_files Toggles whether or not to show files and folders that start with a "dot" bool false
human_readable_size When set to true, the package will display file sizes in a more friendly readable format bool true
human_readable_datetime When set to true, the package will display dates with diffForHumans() bool true
file_analysis.enable When set to true, the package will use getID3 to parse metadata from the files bool true
file_analysis.cache.enable When set to true, the package will cache the file analysis result bool true
file_analysis.cache.ttl_in_seconds TTL for analysis caching in seconds int 86400
url_signing.enabled When set to true, all the file urls will be signed bool false
url_signing.unit Defines the unit for the expiration time string minutes The expiration time must not exceed 1 week
url_signing.value Defines the value for the expiration time int 10

For a full list of updated configuration options, please refer to the full documentation at https://oneduo.github.io/nova-file-manager/configuration.html

Authors

See also the list of contributors who participated in this project.

Screenshots

You can find more screenshots here https://oneduo.github.io/nova-file-manager/screenshots.html.

Changelog

Please see CHANGELOG for more information what has changed recently.

Security

If you discover any security related issues, please email [email protected] instead of using the issue tracker.

Contributing

Please see CONTRIBUTING for details.

Credits

License

The MIT License (MIT). Please see License File for more information.