https://github.com/unicodeveloper/media-blade-uikit
https://github.com/unicodeveloper/media-blade-uikit
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/unicodeveloper/media-blade-uikit
- Owner: unicodeveloper
- License: mit
- Created: 2022-08-28T06:40:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-01T03:34:08.000Z (about 2 years ago)
- Last Synced: 2025-03-31T09:11:11.208Z (10 months ago)
- Language: PHP
- Size: 2.5 MB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# media-blade-uikit.org
Source code for [media-blade-uikit.org](https://media-blade-uikit.org).
## Credits
Thanks to [Dries Vints](https://github.com/driesvints) and team for the source code of [blade-ui-kit.com](https://blade-ui-kit.com).
## Requirements
The following tools are required in order to start the installation.
- PHP >=8.0
- [Composer](https://getcomposer.org/download/)
- [NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
## Installation
1. Clone this repository locally with `git clone git@github.com/unicodeveloper/media-blade-uikit.git media-blade-uikit.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)](#meilisearch)
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](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](https://docs.meilisearch.com/learn/getting_started/installation.html#download-and-launch).
After that, create an `icons` index using:
```bash
php artisan scout:index icons
```
Then, import all icons into the search using:
```bash
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](http://127.0.0.1:8000/blade-icons).
You can clear all icons again by running:
```bash
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