davesweb/dashboard

Laravel admin dashboard package

dev-main 2021-11-28 04:11 UTC

Requires

• php: ^8.0
• doctrine/dbal: ^3.1
• illuminate/console: ^8.0
• illuminate/support: ^8.0
• laravel/fortify: ^1.8

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.2
• orchestra/testbench: ^6.22

MIT

README

An admin dashboard for Laravel applications. It comes with a default bootstrap 5 template, but it's 100% customizable. You can use your own views and assets to either overwrite certain parts or use a completely different template.

Installation

Via composer

composer require davesweb/dashboard

After that, publish the assets by running

php artisan vendor:publish --provider=Davesweb\Dashboard\Providers\ServiceProvider

Run the migrations

php artisan migrate

The dashboard is now available, by default at yoursite.ext/dashboard. You can configure the route in de dashboard.php config file.

Create the first user for your dashboard by running the artisan command.

php artisan dashboard:user

Local Development

For local development, I recommend checking out the package with git and adding it as a path repository to your composer file instead of constantly pushing updates and updating composer.

Building assets

• Go to root folder of the package
• Run npm install and npm run dev (or watch or prod).
• Go to the root folder of the project you're using this package in.
• Run php artisan vendor:publish --provider=Davesweb\Dashboard\Providers\ServiceProvider --tag=public --force
• The assets from the package are now available, use the asset helper for ease of use.

Todos

• Instead of using CSS class names for the icons, use HtmlString objects so we aren't required to use an icon library that is used by specifying class names.
• Add a check for cached routes to the crud route registration and add a command to cache the menu items of crud classes, so we don't need to instantiate every single crud class on every request.
• Add a service class that handles how to render translations, based on the installed translation package so we can support other packages as well.
• Vendor fonts (Font Awesome, Flag Icons) are not build to the correct folder, and therefore are not published with the rest of the assets.

Roadmap / planned features

• Export Crud overview to Excel, CSV
• Relationship columns in overviews

Testing

To run the testsuite, simply run

composer test

Code style

This package uses PHP CS Fixer to enforce code style. To run it, run

composer cs-fixer

License

This package is licensed under the MIT license, which basically means you can do whatever your want with this package. However, if you found this package useful, please consider buying me a beer or subscribing to premium email support over on Patreon, it's really appreciated!