https://github.com/clevertech/yiibackboneboilerplate
YiiBackboneBoilerplate
https://github.com/clevertech/yiibackboneboilerplate
Last synced: about 1 year ago
JSON representation
YiiBackboneBoilerplate
- Host: GitHub
- URL: https://github.com/clevertech/yiibackboneboilerplate
- Owner: clevertech
- Created: 2012-09-11T17:05:31.000Z (almost 14 years ago)
- Default Branch: master
- Last Pushed: 2012-11-25T17:50:11.000Z (over 13 years ago)
- Last Synced: 2025-03-28T02:12:30.413Z (about 1 year ago)
- Language: PHP
- Size: 14 MB
- Stars: 45
- Watchers: 22
- Forks: 21
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# YiiBackboneBoilerplate
We at [***Clevertech***](http://clevertech.biz) use this folder structure setup for our own projects when developing [BackboneJS](http://www.backbonejs.org) applications.
### Overview
**YiiBackboneBoilerplate**, aims to provide *Yii Backbone developers* with an application folder to ease the startup of their projects. It uses the flexibility of our [**YiiBoilerplate**](https://github.com/clevertech/YiiBoilerplate) with a *twist* for BackboneJS applications.
#### What is BackboneJS?
Backbone.js gives structure to web applications by providing models with key-value binding and custom events, collections with a rich API of enumerable functions, views with declarative event handling, and connects it all to your existing API over a RESTful JSON interface.
You may be thinking that Yii is too powerful to be used just as a RESTful service. That for this purpose it could be done with [NodeJS](http://nodejs.org) or any of the other libraries available, but it is the power of Yii and for the sake of application scalability that we decided to use it.
### BackboneJS + Yii
We love to work at [***Clevertech***](http://clevertech.biz) with [Yii](http://www.yiiframework.com), in fact, it is one of the biggest assets of our company nowadays. Nevertheless, we are very aware of the new trends, and we had the opportunity to work with [BackboneJS](http://www.backbonejs.org). So we decided that it could be good to provide a project startup for our developers, and allow us to get the best out of both worlds.
### Backbone Overall Folder Structure
This document will be focused mainly in the folder structure that we set for the Backbone application. Please, read [YiiBoilerplate's README](https://github.com/clevertech/YiiBoilerplate) for a deeper explanation of the main [Yii](http://www.yiiframework.com)
folder structure setup.
Below the directory structure we are using:
/
backend/
...
common/
...
console/
...
frontend/
...
www/
app/
css/
img/
js/
boilerplate/
collections/
libs/
models/
views/
app.js
controller.js
main.js
router.js
vent.js
templates/
tests/
...
####Backbone Application Directories
In the js directory, we have:
* ***boilerplate***: we have created a set of elements for you to create a model, collection, module and/or view. Please, note that the basic application skeleton that we have setup for you is based on [Backbone.Marionette](https://github.com/marionettejs/backbone.marionette), and the views are different from normal Backbone views.
* ***collections***: this is were we place the Backbone collections for our application.
* ***libs***: holds the main libraries. We included the ones we thought would be the most useful.
* ***models***: this is were we place the Backbone models for our application.
* ***views***: and this is where we place the backbone views.
A special note regarding the ***templates*** directory. This folder is normally within the ***js*** folder, but we thought that it would be better to separate UI design from the business logic of the javascript files.
###The _runpostdeploy_ script
This section is actually extracted from [YiiBoilerplate](https://github.com/clevertech/YiiBoilerplate), but it is worth repeating the procedure.
The project has a very handy script that automatically creates the required and folders that are **not** shared for a Yii application, the **runtime** and **assets** folders, extracts the configuration settings specified for a specific environment then copies them to the ****-env.php*** files, and then runs migrations when not on private environments --we believe that migrations should be always run manually by developers on their machines.
To use this, from the application's root folder, simply run:
```
./runpostdeploy environmentType migrations
```
* **environmentType** (required): can be "any" of the ones you configure on the **environments** folders (i.e. `./runpostdeploy private` to use ****-private.php*** configurations)
* **migrations** (optional): could be "**migrate**"" or "**no-migrate**".
* migrate: will run migrations
* no-migrate: will not run migrations (on private we won't run them anyway)
###YiiBooster library
We have included [YiiBooster](http://yii-booster.clevertech.biz) widget library to the boilerplate. For more information regarding this library and its use
please visit [YiiBooster Site](http://yii-booster.clevertech.biz).
###Final Notes
We would like to inform that this is just a startup **boilerplate** for your own projects. It is not intended by any means to be used ***'AS IS'***, but rather as a base to scale to more complicated structures.
Neverteless, we have included a couple of goodies that we hope to improve with the help of the community.
====
> [](http://www.clevertech.biz)
well-built beautifully designed web applications
[www.clevertech.biz](http://www.clevertech.biz)