almeida/ui-kit

A frontend generator that encourages the maintenance of a pattern libary.

0.1.0 2014-03-28 14:48 UTC

This package is not auto-updated.

Last update: 2024-11-09 15:11:50 UTC


README

@todo - Build status License

UIKit is a php toolset to encourage the maintenence of a "Pattern Libary".

This is an alpha alpha release, im just making it public so i am forced to maintain it.

Installing this package by itself probably wont work. Please install the laravel driver and see instructions for basic usage.

https://github.com/arnold-almeida/UIKit-Laravel

Suggestions welcome.

Goals

  • Reduce time writing redundant markup
  • Use a standard language when refering to UI components
  • Best practices approach to markup
  • Allow users to switch between presentation frameworks easily (Foundation/Bootstrap/SemanticUI)
  • Allow users to extend an implementation and maintain their own internal pattern libary

Todo

  • Public release
  • Work out a nice way to manage configuration
  • Write phpspec's for all implementations
  • Docs - How to use with examples
  • Public contents, templates and examples, and more
  • How to for extending

Testing

$ phpspec run

Standards

This package aims to be compliant with PSR-1, PSR-2 and PSR-4. If you notice compliance oversights, please send a patch via pull request.

Requirements

The following versions of PHP are supported by this version.

  • PHP 5.4+

Bibliography

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, Bootstrap is maintained under the Semantic Versioning guidelines. Sometimes we screw up, but we'll adhere to these rules whenever possible.

Releases will be numbered with the following format:

<major>.<minor>.<patch>

And constructed with the following guidelines:

  • Breaking backward compatibility bumps the major while resetting minor and patch
  • New additions without breaking backward compatibility bumps the minor while resetting the patch
  • Bug fixes and misc changes bumps only the patch

For more information on SemVer, please visit http://semver.org/.

Credits

Contributing

Please see CONTRIBUTING for details.

Copyright and license

Code released under the MIT license.