README

YiiBooster is a widget toolkit for Yii web framework. Its main purpose is to ease building UI in Yii-based web applications utilizing the beauty of Twitter Bootstrap and several other great UI plugins developed over time by the community.

Twitter Bootstrap wrapping is based over the excellent job of Christoffer Niska called Yii-Bootstrap. We at Clevertech included his library into our own Yii project startup library, YiiBoilerplate, and started improving it in order to satisfy some of our customers' project requirements. YiiBooster is an end result of this effort.

We tried very hard in past to accommodate to radical changes between successive versions of Twitter Bootstrap, but starting from November 2016 we will just follow the latest stable version published by Twitter. This means that when you upgrade YiiBooster, you upgrade Twitter Bootstrap as well.

Widgets at a glance

Overall, the following is included in YiiBooster:

All of most current Twitter Bootstrap goodness we were able to integrate with.
FontAwesome icons pack for Twitter Bootstrap.
jQuery File Upload widget for fancy file uploads.
jQueryUI/Bootstrap integration.
Select2 widget for fancy selectors.
X-Editable plugin for in-place editing of table cells values.
Absolutely crazy custom grid views called TbExtendedGridView and TbJsonGridView, packed with features to the brim.
Four different WYSIWYG editors for you to choose:
- wysihtml5 with Bootstrap integration,
- jQuery Markdown,
- CKEditor and
- Redactor.
And don't be afraid to use Redactor, because Yii community bought an ORM license for it.
And several other little and not-so-little widgets for you to use.

Quick Start

If you want, you can clone the github repo and get the full codebase to build the distributive or documentation or just to hack something.

If you just want to use YiiBooster, you need to download the latest distributive archive. After that, consult the YiiBooster documentation website or the INSTALL.md file included in the package.

Widgets end-user documentation

Check out YiiBooster documentation website.

Contributing

Long story short: make pull requests from separate branches dedicated for individual features to master. Please see the wiki page about how to contribute to YiiBooster for details.

Requirements

YiiBooster as a project requires (and supports) PHP 5.3 and Yii 1.1.15.

We know that PHP 5.3 is deprecated for several years already and Yii has version 2 released a year ago. A major overwrite is planned, but as for YiiBooster as it is, the dependencies versions stand as they are.

For development we specify explicitly that you'll need PHPUnit 4.8, because it's the last version to support PHP 5.3.

Bug tracker

If you find any bugs, please create an issue at issue tracker for project Github repository.

License

This work as a whole is licensed under a BSD license. Full text is included in the LICENSE file in the root of codebase.

Well-built beautifully designed web applications.

www.clevertech.biz

clevertech / yii-booster

Maintainers

Details