README

The purpose of this package is to install the UIKit3 framework in to the laravel/ui package.

Motivation

I found that I like the UIKit framework a lot. I know there are others out there that use it and I wanted to give a way for user to add it to their Laravel projects..

Screenshots

Tech/framework used

Built with

Features

In Laravel 7, the scaffolding was moved to the laravel/ui package and the options for installing whatever framework I want is limited. Just wanted to make the process a little easier for myself and others who use UIKit.

Installation

To install this package - you call it just like you would when installing any of the other presets.

php artisan ui uikit3

This will install all the necessary pieces of the frontend scaffolding.

How to use?

Since Laravel comes with Composer, we will be using it also. Please make sure it is installed in your development environment.

Step 1 -

composer require cartographr/uikit3-laravel-frontend-ui

Step 2 - Once the package installs, make sure that it appears in your composer.json file in your Laravel project. If it doesn't, please submit an issue ticket.

Step 3 - Once you verify it's in your composer.json file, it will install just like the other laravel ui packages.

php artisan ui uikit3

AUTH - If you want auth routes, you can run

php artisan ui uikit3 --auth

to generate normal Laravel authentication methods. You have to install the framework piece first using

php artisan ui uikit3

before the auth routes will be generated.

Step 4 - Once installed, you will be prompted on the CLI to run

npm install && npm run dev

Once you do that, everything should be ready to go and UIKit should be installed in to your project.

Hope you enjoy it!

Credits

Giving praise to the guys at Laravel Frontend Presets for making the things they do.

Also, the Laravel team for just having it all together. Framework is awesome.

License

This software is published with the MIT license.

cartographr / uikit3-laravel-frontend-ui

Maintainers

Details