https://github.com/seba-1511/booter

The Booter Project: A predefined structure
https://github.com/seba-1511/booter

Last synced: 11 days ago
JSON representation

The Booter Project: A predefined structure

• Host: GitHub
• URL: https://github.com/seba-1511/booter
• Owner: seba-1511
• Created: 2013-05-09T10:44:40.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-09-20T20:44:10.000Z (over 11 years ago)
• Last Synced: 2024-12-02T18:58:29.463Z (24 days ago)
• Language: PHP
• Size: 2.08 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Booter

======

The Booter Project: A predefined structure to kick your projects. This includes:

* CodeIgniter 2.1.3 (With some default configuration. Ex: Autoload, Cookies, etc...)

* jQuery 1.9 and jQuery 2.0 to best match your targeted visitors

* jQuery UI 1.10.3 not themed

* jQuery Mobile 1.3.1

* Bootstrap 2.3.1 JS and CSS

* Less 1.3.3

* HandleBarsJS 1.0.0

* Glyphish Pro 3.0 Icons

* Custom Scripts

# Notes on Custom Scripts

## CodeIgniter's Layout Library

As we don't want to always load the same Headers, Footers, etc... of the page, we implemented a library to do this for us. The principle is that you add views, that will be stored in the class. Then by simply calling the printPage function with

 ```php

 $this->layout->printPage();

 ``` 

 the whole page will be printed. Note that you can also add a JS, CSS and set the title by simply calling the librarie's methods. See an example in the welcome controler.

 Also, you can set your own default layouts by creating them in the views/layout folder. By default, there are only 4 of them:

 * **default** Just an empty HTML5 layout

 * **basic** Only main JavScripts and CSS are imported

 * **quicksite** The starting point for a project, with some elements of Bootstrap

 * **mobile** A simple web app with header and footer

 **IMPORTANT: The Layout Library is imported by default, so remove it in autoload if you don't use it !** 

## CodeIgniter CRUD Model

 The file application/core/MY_CRUD.php implements a basic CRUD implementation. (With count option) The easiest way to understand it is to read the file. We highly recommend to use it as a core function for the different models you'll build, by doing so:

 ```php

 class User_model extends MY_CRUD

{

    protected $table = 'users';

}

 ```

## Booter JS

Booter has its own JavaScript Class, found in the file assets/js/booter.utils.js. This file has some functions that I found usefull, and that can be used in about any projects. To use it, just call 

```javascript

booter.theNameOfThePublicMethod();

```

## License

Copyright (C) 2013 Sébastien Arnold

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:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

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.