Merge branch 'release/5.0.0-beta.3'

.gitignore

@@ -36,3 +36,5 @@ platforms/wordpress/gantryadmin/cache
 platforms/common/node_modules
 assets/application/node_modules
 assets/common/application/node_modules
+assets/common/node_modules
+engines/common/nucleus/node_modules

README.md

@@ -25,8 +25,8 @@ Gantry 5 is a framework by which Gantry-powered themes are made. In order for a
 
 The first thing you need to do is download the latest build of Gantry 5 and Hydrogen. You can do so by clicking the links below, or via [GitHub](http://github.com/gantry/gantry5/).
 
-* [Download Gantry 5](https://github.com/gantry/gantry5/releases/download/5.0.0-beta.2/joomla-pkg_gantry5_v5.0.0-beta.2.zip)
-* [Download Hydrogen Theme](https://github.com/gantry/gantry5/releases/download/5.0.0-beta.2/joomla-tpl_g5_hydrogen_v5.0.0-beta.2.zip)
+* [Download Gantry 5](https://github.com/gantry/gantry5/releases/download/5.0.0-beta.3/joomla-pkg_gantry5_v5.0.0-beta.3.zip)
+* [Download Hydrogen Theme](https://github.com/gantry/gantry5/releases/download/5.0.0-beta.3/joomla-tpl_g5_hydrogen_v5.0.0-beta.3.zip)
 
 >>> During the initial beta, the **Framework** and **Template** are being distributed in different installable packages. A bundled package is planned, but will likely be available after the initial beta launch.
 
@@ -88,3 +88,30 @@ A chat room has been set up using [Gitter](https://gitter.im/gantry/gantry5) whe
 Contributing to the Gantry 5 framework, or to its associated documentation is easy. Development for both of these projects is being conducted via [Github](http://github.com), where you can submit **Issues** to report any bugs or suggest improvements, as well as submit your own **Pull Requests** to submit your own fixes and additions.
 
 We recommend chatting with the team via [Gitter](https://gitter.im/gantry/gantry5) prior to submitting the pull request to avoid doubling up on a fix that is already pending or likely to be overwritten by an upcoming change.
+
+## Bundling JS and Compiling SCSS
+
+In our development environment, we use **Gulp** to bundle **JavaScript** and compile **SCSS** with the capability of `watch` so that any change on target files will automatically trigger the recompilation.
+
+If you would like to set this up in your own development environment, you can do so following these simple instructions.
+
+> Note that for this to work, you need to have **Gantry 5** source and not a package. You can either **clone** it or **download** the source from GitHub.
+
+The first thing you need is `Node / NPM`. If you don’t have them already, you can grab the installer for your OS from [https://nodejs.org/download/](https://nodejs.org/download/).
+
+Once that’s done, you can install **Gulp**. We recommend installing Gulp globally so you can use the command from any folder. Here is the command to do so: `npm install —-global gulp`
+
+Now that you have the required pieces, the next step is to install all of the JS module dependencies. To do so, make sure you are at the root of the Gantry 5 project, and run the command `npm install`.
+
+Because we have two sets of JS applications, one for admin and one for the site, you will also need to install the JS modules for those. Still, from the root of your project you can run this command:
+
+`cd platforms/common/ && npm install && cd ../../assets/common/ && npm install && cd ../../`
+
+At this point you have everything you need to run Gulp. Just type the command `gulp` and you should see the CSS and JS getting compiled.
+
+We provide a few handy tasks as well:
+
+  1. `$ gulp` / `$ gulp all`: Compiles all of the CSS and JS in the project.
+  2. `$ gulp watch`: Starts the compilers in `watch` mode. Any change applied to targeted **JS** or **SCSS** files will trigger an automatic recompilation.
+  3. `$ gulp css` / `$ gulp js`: Compiles all of either CSS or JS files, in case you are only working on one and not the other.
+  4. `$ gulp —prod`: Compiles every CSS and JS in production mode. The compiled files won’t have source maps and will be compressed (this usually takes slightly longer than normal mode).

VERSION

@@ -1 +1 @@
-5.0.0-beta.2
+5.0.0-beta.3

assets/common/application/main.js

@@ -1,5 +1,20 @@
 "use strict";
 
-module.exports = {
-    menu: require('./menu')
-};
+var ready     = require('domready'),
+    menu      = require('./menu'),
+    offcanvas = require('./offcanvas'),
+    $         = require('./utils/dollar-extras'),
+
+    instances = {};
+
+ready(function() {
+    instances = {
+        offcanvas: new offcanvas(),
+        menu: new menu(),
+        $: $
+    };
+
+    module.exports = window.G5 = instances;
+});
+
+module.exports = window.G5 = instances;