nulayuhz/magento-boilerplate

Magento Boilerplate including LESS CSS and other goods.

Magento Boilerplate

Author: Jason Alvis
Author Email: [email protected]
Version: 1.0.0
License: Free General Public License (GPL)

Brief

Starting a Magento project the right way is a must for any developer. This project has many benefits and is the base framework for any new project I start. It adheres to the recommended Magento templating hierarchy and works staight out of the box. Plug, play and enjoy! Oh did I mention it's free to use as well?

Goods

Custom Templates

It includes custom templates for the home page, category, product and static pages. The category and product pages are already set in local.xml. You can set the home page and any CMS static pages to their corresponding custom template via the admin panel under CMS > Pages. Select the page in question and in the design tab select the layout from the drop down field.

• Home = home.phtml
• Static = static.phtml

Removes default xml blocks

Removes default xml blocks that are rarely used from within local.xml

HTML5/CSS3 Ready and includes Modernizr

Ready to use HTML5 tags and CSS3 selectors.

Includes jQuery in no conflict mode

jQuery 1.7.2 minified version in no conflict mode is included as default. You can change this to include the latest version of jQuery if you wish.

Custom JavaScript files per template and Plugins JavaScript File

Need a seperate .js file just for the home page? It's got that included as default, great for specifying JavaScript that is only to be rendered on certain pages.

• common.js (included on every page)
• home.js (included on the home page only)
• category.js (included on the category page only)
• product.js (included on the product page only)
• static.js (included on the static page only)

There is also an all rounder plugin js file (plugins.all.min.js) whereby you can put in your various JavaScript plugins such as jQuery UI, Easing, MouseWheel etc.

LESS CSS Included

It includes LESS CSS as default, if your new to this I would highly recommend checking it out by visiting their website http://lesscss.org/. If you don't want to use LESS it can be removed very easily within local.xml and head.phtml

Installation

Drop in the templates app and skin within your Magento hierarchy e.g:
magento > public_html > app
magento > public_html > js
magento > public_html > skin

You will then need to rename the "mypackagename" to a name of your choice in both the app and skin directories. Then you will need to change the package name in the admin panel to render the new package you have just installed (system > configuration > design > package).