> For the complete documentation index, see [llms.txt](https://exiang.gitbook.io/yeebase/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://exiang.gitbook.io/yeebase/master.md).

# Getting Started

`Yee` is a custom layer I wrote on top of Yii Framework version 1 to make life easier when building web applications across different projects. It consists of mainly 3 parts:

#### YeeBase

Under `/protected/yeebase`, it has own modules, components, extensions, filters, models and views. Core code the reusable across projects sits in here and form the backbone of `Yee` application project.

#### Inspinia

Under `/public_html/themes/inspinia` is a theme using a commercial bootstrap 3 skin called `insipinia`. This gives the standardized ui/ux to all `Yee` application project. Compare to the default Inspinia package, it is heavily customized but allows developer to easily upgrade (by just replacing files). 

#### Yee

A code generator branch out from `Gii` (Yii framework default code generator), this make your job easier by writing less code. Generated code is compatible and works side by side with `YeeBase` and `Inspinia` theme. 

`Yee` is heavily customized and not compatible with \`Gii\` for a straightforward upgrade (by just replacing files).

### Git Submodule

These codes sits on separate GIT repo and can be include to any of your Yii project through Git Submodule.