Skip to content

nuernbergerA/blade-ui-kit.com

 
 

Repository files navigation

blade-ui-kit.com

Tests Code Style

The source code for blade-ui-kit.com

Requirements

The following tools are required in order to start the installation.

Installation

  1. Clone this repository locally with git clone git@github.com:blade-ui-kit/blade-ui-kit.com.git blade-ui-kit.com
  2. Copy the .env.example file to .env
  3. Install the PHP dependencies with composer install
  4. Generate a new app key with php artisan key:generate
  5. Install and compile the front-end dependencies with npm install && npm run dev
  6. Import all icon sets using php artisan icons:import
  7. Set up Meilisearch (optionally)
  8. Serve the website locally by running php artisan serve

You can now visit the app in your browser by visiting http://127.0.0.1:8000.

Meilisearch

To get up and running with Meilisearch for the website locally, first make sure you download and launch Meilisearch.

After that, create an icons index using:

php artisan scout:index icons

Then, import all icons into the search using:

php artisan scout:import "App\\Models\\Icon"

Now all icons from all icon sets are indexed and searchable at http://127.0.0.1:8000/blade-icons.

You can clear all icons again by running:

php artisan scout:flush "App\\Models\\Icon"

Commands

Command Description
php artisan test Run the tests
php artisan migrate:fresh --seed Reset the database
php artisan icons:import Import all icon sets into Sqlite
npm run watch Watch for changes in CSS and JS files

About

Source code for the Blade UI Kit website and documentation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 68.8%
  • Blade 30.6%
  • Shell 0.6%