Yii-Bum-Stack

Front End Stack for Backbone and Marionette development with Yii. Uses grunt for modularity instead of requirejs.

Bum - a nickname and acronym: Backbone, Underscore and Marionette.

Getting Started

This package requires Yii, NodeJS, Bower, and Grunt.

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins.

Overview

The following guide aims to explain how to scaffold your project to work with Yii-Bum-Stack. Two guides available:

Quick Start
In-depth setup

Quick Start:

Clone into your project directory:

git clone https://github.com/dtison/Yii-Bum-Stack.git

Install vendor Dependencies:

bower install

Install grunt Dependencies:

npm install . --save dev

Alternatively, you may use grunt<enter> to run bower and npm install.

Additional set up is required, see Defaults

In-depth setup:

Clone into your project directory:

git clone https://github.com/dtison/Yii-Bum-Stack.git

Dependencies:

Once the package has been installed, you must get dependencies from your site root:

bower install

Bower - manages retrieval and storage of all the js libraries used.

npm install . --save-dev

Example

Then to run the example, cd src/sponsor

cd src/sponsor
grunt

Should load all the packages needed.

Using grunt watch

This package comes with an advanced grunt-watch feature that allows you to sync with your developement stage or production. To use, create an rsync.json file and put it in your root directory:

{
    "options": "-rvp --progress -a --delete -e 'ssh -q' --include '*.' ",
    "user": "username",
    "host": "hostname.com",
    "path": "/directory/to/public_html"
}

Building from source

grunt build

Will concantenate your source files and produce one file in /public_html/js

Should say: Done, without errors.

Defaults

When using Yii, it is important to make sure the following directories have 777 permissions:

public_html/assets
public_html/debug
public_html/protected/runtime

.htaccess must be in public_html on the server. If you don't have one working with Yii, this one works:

RewriteEngine On

# If a directory or a file exists, use it directly.
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d

# Else, forward it to index.php.
RewriteRule . index.php

php_value upload_max_filesize 80M
php_value post_max_size 80M

Usage Example

TBD

Result:

TBD

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

0.0.2 : Fixes README, other details 0.0.1 : First Release

dtison/Yii-Bum-Stack