README

All I've done is make a package from the icon portion of Blade UI Kit website, which incidentally can be used to set up icon relationships in your Eloquent models.

Installation

You can install the package via composer:

composer require headerx/buku-icons

You can publish and run the migrations with:

php artisan vendor:publish --provider="HeaderX\BukuIcons\BukuIconsServiceProvider" --tag="buku-icons-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --provider="HeaderX\BukuIcons\BukuIconsServiceProvider" --tag="buku-icons-config"

This is the contents of the published config file:

<?php

return [
    'route_prefix' => '/blade-icons',

    'middleware' => [
        'web',
    ],

    'db_connection' => env('DB_CONNECTION', 'mysql'),
];

Usage

Publish migrate and import in one step

php artisan buku-icons:install

Or publish configuration and migrations and migrate manually, then run

php artisan buku-icons:import

run artisan serve then visit http://localhost:8000/blade-icons and see over 50,000 icons searchable with livewire!

See https://github.com/blade-ui-kit/blade-ui-kit.com for more info.

If you like this package and want to make a donation, please visit https://github.com/sponsors/driesvints.

I personally am not accepting donations at this time, thank you.

P.S I am currently accepting PR's for the folowing:

I would like to bring back in support for meilisearch with scout, but had to disable it for now to allow a standard search scope. What I would like is to have a singleton with a repository layer to allow configuring the use of custom Icon models.

Instead for now I've just allowed for confuration of the connection in case you just want to use this for an ad hoc script for loading all the icons into an Sqlite database or something of that nature.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

headerx / buku-icons

Maintainers

Details