You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 18, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+26-29Lines changed: 26 additions & 29 deletions
Original file line number
Diff line number
Diff line change
@@ -2,67 +2,64 @@
2
2
3
3

4
4
5
-
**THIS README IS A WORK IN PROGRESS AND IS NOT YET COMPLETE**
6
-
7
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.
8
6
9
-
Whilst Bootstrap is a very popular front-end framework, with lots of fans, I much prefer a framework 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.
7
+
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.
10
8
11
9
This repository contains my alternative to the stock preset that [Laravel UI](https://github.com/laravel/ui) provides.
12
10
13
11
## Getting Started
14
12
15
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.
16
14
17
-
### TODO: Prerequisites
15
+
### Prerequisites
18
16
19
-
To begin, you'll need a fresh install of Laravel 6. Something like the following will get you up and running on an Ubuntu-based development machine:
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:
20
18
21
19
```
22
-
Give examples
20
+
composer global require laravel/installer
21
+
22
+
laravel new mysite
23
+
24
+
php artisan serve
23
25
```
24
26
25
-
### TODO: Installing
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).
26
28
27
-
A step by step series of examples that tell you how to get a development env running
29
+
### Installing this preset
28
30
29
-
Say what the step will be
31
+
To turn a stock bootstrap-based install into a UIkit skeleton site, follow the steps below.
32
+
33
+
1. Include this repository into your composer dependencies:
2. Run the artisan command to install the preset into your Laravel install. It will ask you if you'd like to overwite welcome.blade.php. As long as you haven't started changing your blade files, this is fine to proceed with:
36
40
37
41
```
38
-
until finished
42
+
php artisan ui vue --auth
39
43
```
40
44
41
-
End with an example of getting some data out of the system or using it for a little demo
42
-
43
-
## TODO: Running the tests
44
-
45
-
Explain how to run the automated tests for this system
46
-
47
-
### Break down into end to end tests
48
-
49
-
Explain what these tests test and why
45
+
3. Finally, run NPM to download UIkit, and build your assets using Laravel Mix:
50
46
51
47
```
52
-
Give an example
48
+
npm install && npm run dev
53
49
```
54
50
55
-
### And coding style tests
56
-
57
-
Explain what these tests test and why
51
+
4. (optional) Whilst developing your site, running Mix in watch mode makes it easy to make changes and quickly see their results:
58
52
59
53
```
60
-
Give an example
54
+
npm run watch
61
55
```
62
56
63
-
## TODO: Deployment
57
+
## Deployment
64
58
65
-
Add additional notes about how to deploy this on a live system
59
+
When deploying to a live server, ensure to build your assets in production mode for smaller, faster downloads:
60
+
```
61
+
npm run prod
62
+
```
66
63
67
64
## Built With
68
65
@@ -72,7 +69,7 @@ Add additional notes about how to deploy this on a live system
72
69
73
70
## Contributing
74
71
75
-
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) for details on our code of conduct, and the process for submitting pull requests to us.
72
+
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
0 commit comments