The source code for blade-ui-kit.com
The following tools are required in order to start the installation.
- PHP 8.5 or later in the PHP 8.x series
- Composer
- Node.js and NPM (Node 20.19+ or 22.12+; CI uses Node 26)
- Clone this repository locally with
git clone git@github.com:blade-ui-kit/blade-ui-kit.com.git blade-ui-kit.com - Copy the
.env.examplefile to.env - Install the PHP dependencies with
composer install - Generate a new app key with
php artisan key:generate - Install and compile the front-end dependencies with
npm install && npm run dev - Import all icon sets using
php artisan icons:import - Set up Meilisearch (optionally)
- 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.
Run .agents/setup to install PHP 8.5 and Composer, install dependencies from the lockfiles,
prepare SQLite, cache and import the icon sets, and build the frontend assets. Node.js and npm
are provided by the orb. Re-running setup preserves an existing .env and app key, applies pending
migrations to the local database/database.sqlite, and refreshes the imported icon catalogue.
For a fresh .env, setup selects SQLite, log-only mail, and Scout's collection driver so local
search works without Meilisearch. Collection search is intended for development, not performance
or Meilisearch-specific search testing. Follow the Meilisearch instructions below when needed.
Run php artisan test to run the tests. Run amp orb services ensure to start the supervised
web server and print its portal URL. Assets are prebuilt; use npm run build after frontend edits
or run npm run dev as a supervised orb service for watch mode. No resume hook is needed because
SQLite and the built assets persist without a database daemon.
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 iconsAfter creating the index, you'll need to configure a filterable attribute for the icon sets:
curl \
-X PUT 'http://localhost:7700/indexes/icons/settings/filterable-attributes' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer masterKey' \
--data-binary '[
"icon_set_id"
]'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"| 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 dev |
Watch for changes in CSS and JS files |