Skip to content
This repository was archived by the owner on Sep 18, 2020. It is now read-only.

Commit 86bd2ad

Browse files
committed
WIP
1 parent e8ee91c commit 86bd2ad

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,21 @@
22

33
![](https://torrix.uk/laravel-ui-uikit.jpg)
44

5-
Out of the box, Laravel ships with a [UI preset](https://github.com/laravel/ui) for [Bootstrap](https://getbootstrap.com/) and [Vue](https://vuejs.org/) to make getting your website front-end up and running simple.
5+
Out of the box, Laravel ships with a [UI preset](https://github.com/laravel/ui) for [Bootstrap](https://getbootstrap.com/) and [Vue.js](https://vuejs.org/) to make getting your website front-end up and running simple.
6+
7+
## Laravel + UIkit = :heart_eyes:
68

79
Whilst Bootstrap is a very popular front-end framework, with lots of fans, I much prefer a framework made by [YOOtheme](https://yootheme.com/) called **[UIkit](https://getuikit.com/)** myself. It's modern, clean, well-thought-out, and modular. It's my go-to framework now for websites and web applications, from tiny single-page landing sites, to massive web applications with thousands of users.
810

911
This repository contains my alternative to the stock preset that [Laravel UI](https://github.com/laravel/ui) provides.
1012

1113
## Getting Started
1214

13-
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
15+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Deployment for notes on how to deploy the project on a live system.
1416

1517
### Prerequisites
1618

17-
To begin, you'll need a fresh install of Laravel 6. This in turn needs Composer, which for convenience is best installed globally. Something like the following will get you up and running:
19+
To begin, you'll need a **fresh** install of Laravel 6. **Adding this to an existing project is not recommended and may cause issues**. For full instructions on installing Laravel, refer to the [Laravel installation docs](https://laravel.com/docs/6.x/installation), but something like the following will get you up and running:
1820

1921
```
2022
composer global require laravel/installer
@@ -24,11 +26,11 @@ laravel new mysite
2426
php artisan serve
2527
```
2628

27-
Your development site will be served at http://localhost:8000. If you have problems getting this far, refer to the [Laravel installation docs](https://laravel.com/docs/6.x/installation).
29+
Your development site will be served at http://localhost:8000.
2830

2931
### Installing this preset
3032

31-
To turn a stock bootstrap-based install into a UIkit skeleton site, follow the steps below.
33+
To turn this stock Bootstrap-based install into a UIkit skeleton site, follow the steps below.
3234

3335
1. Include this repository into your composer dependencies:
3436

@@ -48,15 +50,23 @@ php artisan ui vue --auth
4850
npm install && npm run dev
4951
```
5052

51-
4. (optional) Whilst developing your site, running Mix in watch mode makes it easy to make changes and quickly see their results:
53+
## Developing with UIkit
54+
55+
To get started in UIkit, read [their excellent docs](https://getuikit.com/docs/introduction). The examples and tests provided should give you all the help you need. To get an idea of what UIkit is capable of, I highly recommend the [KickOff starter templates](https://zzseba78.github.io/Kick-Off/) for inspiration.
56+
57+
To start customising UIkit to your own needs, take a look in [app.scss](src/Presets/uikit-stubs/app.scss). In there ,you will find the standard UIkit imports, and by way of a simple example, I've changed the default blue primary colour to a nice purple shade, just to show what's possible in almost no time at all. Try changing it to another colour, and then running `npm run dev` to rebuild the CSS, and see the changes to your site.
58+
59+
### Handy tip
60+
61+
Whilst developing your site, running Laravel Mix in watch mode makes it easy to make changes and quickly see their results:
5262

5363
```
5464
npm run watch
5565
```
5666

5767
## Deployment
5868

59-
When deploying to a live server, ensure to build your assets in production mode for smaller, faster downloads:
69+
When deploying to a live server, remember to build your assets in production mode for smaller, faster downloads:
6070
```
6171
npm run prod
6272
```

0 commit comments

Comments
 (0)