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

Commit 75e5c62

Browse files
committed
WIP: Switch package from bootstrap to uikit
1 parent b391fea commit 75e5c62

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+4307
-719
lines changed

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
/vendor
22
/.idea
3-
composer.phar
4-
composer.lock
53
.DS_Store
64
Thumbs.db
5+
.phpunit.result.cache

.styleci.yml

Lines changed: 0 additions & 5 deletions
This file was deleted.

CHANGELOG.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
4+
5+
Please note we have a code of conduct, please follow it in all your interactions with the project.
6+
7+
## Pull Request Process
8+
9+
1. Ensure any third-party dependencies (e.g.: vendor and node_modules) are removed before creating a build.
10+
2. Update the README.md with details of any important changes to the install procedure, useful file locations etc.
11+
3. Increase the version numbers in any example files and README.md to the new version that this Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
12+
13+
## Code of Conduct
14+
15+
### Our Pledge
16+
17+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
18+
19+
### Our Standards
20+
21+
Examples of behavior that contributes to creating a positive environment include:
22+
23+
* Using welcoming and inclusive language
24+
* Being respectful of differing viewpoints and experiences
25+
* Gracefully accepting constructive criticism
26+
* Focusing on what is best for the community
27+
* Showing empathy towards other community members
28+
29+
Examples of unacceptable behavior by participants include:
30+
31+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
32+
* Trolling, insulting/derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
35+
* Other conduct which could reasonably be considered inappropriate in a professional setting
36+
37+
### Our Responsibilities
38+
39+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
42+
43+
### Scope
44+
45+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
46+
47+
### Enforcement
48+
49+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at matt@torrix.uk. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
50+
51+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
52+
53+
### Attribution
54+
55+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
56+
57+
[homepage]: http://contributor-covenant.org
58+
[version]: http://contributor-covenant.org/version/1/4/

LICENSE.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,10 @@
1-
The MIT License (MIT)
1+
# The MIT License (MIT)
22

3-
Copyright (c) Taylor Otwell
3+
Original work copyright (c) Taylor Otwell
4+
Modified work copyright (c) 2019 Matt Fletcher
45

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
6+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
117

12-
The above copyright notice and this permission notice shall be included in
13-
all copies or substantial portions of the Software.
8+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
149

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21-
THE SOFTWARE.
10+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 80 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,86 @@
11
# UIkit UI preset for Laravel
22

3-
## Introduction
3+
**THIS README IS A WORK IN PROGRESS AND IS NOT YET COMPLETE**
44

5-
Laravel by default ships with a UI preset for [Bootstrap](https://getbootstrap.com/) and [Vue](https://vuejs.org/). I prefer [UIkit](https://getuikit.com/) though, so this is my alternative to the stock presets.
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.
6+
7+
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.
8+
9+
This repository contains my alternative to the stock preset that [Laravel UI](https://github.com/laravel/ui) provides.
10+
11+
## Getting Started
12+
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.
14+
15+
### TODO: Prerequisites
16+
17+
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:
18+
19+
```
20+
Give examples
21+
```
22+
23+
### TODO: Installing
24+
25+
A step by step series of examples that tell you how to get a development env running
26+
27+
Say what the step will be
28+
29+
```
30+
Give the example
31+
```
32+
33+
And repeat
34+
35+
```
36+
until finished
37+
```
38+
39+
End with an example of getting some data out of the system or using it for a little demo
40+
41+
## TODO: Running the tests
42+
43+
Explain how to run the automated tests for this system
44+
45+
### Break down into end to end tests
46+
47+
Explain what these tests test and why
48+
49+
```
50+
Give an example
51+
```
52+
53+
### And coding style tests
54+
55+
Explain what these tests test and why
56+
57+
```
58+
Give an example
59+
```
60+
61+
## TODO: Deployment
62+
63+
Add additional notes about how to deploy this on a live system
64+
65+
## Built With
66+
67+
* [Laravel](https://laravel.com/) - The awesome PHP framework that makes all of this worthwhile.
68+
* [Laravel UI](https://github.com/laravel/ui) - The default Bootstrap preset Laravel ships with, and this project is based on.
69+
* [UIkit](https://getuikit.com/) - The beautiful, powerful front-end framework that you'll be delighted to build your next Laravel project with!
70+
71+
## Contributing
72+
73+
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.
74+
75+
## Versioning
76+
77+
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/Torrix/laravel-ui-uikit/tags).
78+
79+
## Authors
80+
81+
* **Matt Fletcher** - *This UIkit preset* - [Torrix](https://torrix.uk)
82+
* **Taylor Otwell** - *The original Bootstrap preset* - [Laravel UI](https://github.com/laravel/ui)
683

784
## License
885

9-
This preset follows the license of Laravel UI itself, and is therefore open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
86+
This preset is based on and extends the license of Laravel UI itself, and is therefore open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT) - see the [LICENSE.md](LICENSE.md) file for details

composer.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
{
22
"name": "torrix/laravel-ui-uikit",
33
"description": "Laravel UI preset for UIkit.",
4-
"keywords": ["laravel", "ui", "uikit"],
4+
"keywords": [
5+
"laravel",
6+
"ui",
7+
"uikit"
8+
],
59
"license": "MIT",
610
"authors": [
711
{
@@ -16,6 +20,7 @@
1620
"illuminate/support": "~5.8|^6.0"
1721
},
1822
"require-dev": {
23+
"roave/security-advisories": "dev-master",
1924
"mockery/mockery": "^1.0",
2025
"phpunit/phpunit": "^8.0"
2126
},

0 commit comments

Comments
 (0)