invertase · alfecu · Aug 27, 2014 · Aug 27, 2014 · Aug 20, 2014 · Aug 31, 2014
diff --git a/.gitignore b/.gitignore
@@ -41,3 +41,6 @@ Icon
 
 # Bower components
 /src/bower_components
+
+# IDEA
+/.idea
diff --git a/README.md b/README.md
@@ -1,51 +1,47 @@
 ## AngularJS + Bootstrap Responsive Dashboard
 
-This dashboard front-end was created as I was lacking a simple responsive but slick looking dashboard for another project of mine.  Other available dashboards were bloated with external plugins and required a lot of hackery/work out of the box - plus the fact many were powered by jQuery. The design takes inspiration from other dashboards around, but the code to create the layout is my own.
+This AngularJS driven dashboard was created as there is a lack of free, open-source, readable and bloat free admin templates. Many premium templates require a lot of hackery out of the box - this template is intended to have only the extra features we think are needed to get up and running as quick as possible.
 
-Compatibility/Tested:
-* Chrome, Firefox, IE 11+
-* Works best on screen sizes greater than ~335px
+> [Live Demo!](http://ehesp.github.io/Responsive-Dashboard)
 
-[Responsive Screenshots](http://ami.responsivedesign.is/?url=http://ehesp.github.io/Responsive-Dashboard/)
+[*Want the dashboard without AngularJS and build functionality?*](https://github.com/Ehesp/Responsive-Dashboard/tree/barebones)
 
-Live Example:
-* http://ehesp.github.io/Responsive-Dashboard/
-
-> jQuery version available on the [jQuery branch](https://github.com/Ehesp/Responsive-Dashboard/tree/jquery)!
-
-### Usage
-
-Simply clone, or download and unzip this repository and access the dist folder via your browser. There is only one page on show (`index.html`), and the relevant sections have been commented.
-
-### Development
-
-Requirements:
+### Requirements
 * [Node](http://nodejs.org/)
 * [NPM](http://npmjs.org/)
 
-The project uses:
+### Usage
+
+This project uses the following tools:
 * [Gulp](http://gulpjs.com/)
 * [Bower](http://bower.io/) 
 * [AngularJS](https://angularjs.org/)
 
 #### Getting Started
 
-Clone the repo, run `npm install` to install all dependencies.
-After that you can either: 
-- Run `node_mopdules/.bin/gulp build` to build the project.
-- Run `node_mopdules/.bin/gulp` to start a local webserver with **AWESOME** automatic compilation and [Livereload](http://livereload.com/) (We use [gulp-connect](https://github.com/avevlad/gulp-connect)).
+1. Clone the repository and run `npm install` to install all dependencies. This will also run the `bower install` automatically after completion.
+2. There are now two `gulp` commands to choose from:
+- `node_modules/.bin/gulp build` to build the project.
+- `node_modules/.bin/gulp` to start a local webserver with **AWESOME** automatic compilation and [Livereload](http://livereload.com/) (We use [gulp-connect](https://github.com/avevlad/gulp-connect)).
+3. The files will now be built into the `dist` directory.
+
+### Styling
 
-### Stylesheets
+Currently, only the sidebar colours can be easily be changed. [LESS](http://lesscss.org/) is used for styling so we take advantage of variables - checkout `src/less/dashboard/variables.less` and change the sidebar base colour, the others will be converted for you.
 
-#### Theme
+#### Hamburg Menu
 
-Responsive Dashboard uses [LESS](http://lesscss.org/) for styling so we take advantage of variables to theme the dashboard. Take a look at `src/less/dashboard/variables.less` and customize with your own colors.
+By default the responsive dashboard menu on a small sized screen sticks to the left side of the screen. If you wish the menu to have 'native app' menu functionality, where the sidebar overlaps the content from the left and side, simply add the `hamburg` class to the body:
 
-#### Bootstrap + Font Awesome
+```HTML
+<body class="hamburg">
+```
 
-The grid layout and components are powered by [Bootstrap](http://getbootstrap.com/), also Font Awesome icons are ready to use.
+### Bootstrap & Font Awesome
 
-##### Widgets
+The grid layout and components are powered by [Bootstrap](http://getbootstrap.com/), also [Font Awesome](http://fontawesome.io/) icons are ready to use.
+
+#### Widgets
 
 A widget is essentially a white container box with some styling, that will expand 100% of it's parent container. To separate these out, I suggest putting them inside a bootstrap grid item, e.g:
 
@@ -60,7 +56,7 @@ Any content can be inside a `widget-body`, which will be padded by default. Thre
 
 > If no size is set, the content will expand vertically based on content size.
 
-###### Widget Body
+##### Widget Body
 
 **Padding**
 
@@ -106,14 +102,44 @@ Usage of the directive: `<rd-loading></rd-loading>` or `<div rd-loading></div>`
 
 If you want to change it, simply replace the template and CSS!
 
-#### Widget component
+##### Widget component
 
-Usage: 
+Instead of hardcoding the widget HTML directly, AngularJS widget component functionality is ready to use:
+
+```HTML
+<rd-widget>
+  <rd-widget-header icon="fa-tasks" title="Awesome Widget">
+    <a href="#" class="pull-right">Widget Link</a>
+  </rd-widget-header>
+  <!-- Classes are optional but allow you to style the widget-body. -->
+  <rd-widget-body classes="medium no-padding">
+    <p>Hello world from a widget!</p>
+  </rd-widget-body>
+</rd-widget>
+```
+
+Loading widget
 
 ```HTML
 <rd-widget>	
 	<rd-widget-header title="Hello World"><rd-widget-header>
 	<!-- The if the loading parameter is true, it will show an spinner instead of the content.-->
 	<rd-widget-body loading="true">Hello Universe<rd-widget-body>
-<rd-widget>
-```
+</rd-widget>
+```
+
+
+### FAQ
+
+#### What is the dashboard compatible with?
+
+The dashboard uses CSS3 for animations along with other style enhancements meaning browsers supporting this (Chrome, Firefox, IE11+) are compatible.
+As for smaller screen sizes, the dashboard works best on screen sizes greater than ~335px.
+
+#### Any screenshots?
+
+Checkout [am-i-responsive](http://ami.responsivedesign.is/?url=http://ehesp.github.io/Responsive-Dashboard), this doesn't have the Hamburg menu enabled though.
+
+#### I don't want to use AngularJS or NPM/Bower/Gulp!
+
+No worries, theres a barebones branch available with the basic HTML and CSS!
diff --git a/gulpfile.js b/gulpfile.js
@@ -1,58 +1,120 @@
 var gulp    = require('gulp'),
   less      = require('gulp-less'),
-  usemin    = require('gulp-usemin'),
   wrap      = require('gulp-wrap'),
+  watch     = require('gulp-watch'),  
+  concat    = require('gulp-concat'),
+  insert    = require('gulp-insert'),
+  uglify    = require('gulp-uglify'), 
   connect   = require('gulp-connect'),
-  watch     = require('gulp-watch');
+  cssmin    = require('gulp-minify-css'),
+  templates = require('gulp-angular-templates');
+
+var vendors = [
+  'src/bower_components/angular/angular.js',
+  'src/bower_components/angular-cookies/angular-cookies.js',
+  'src/bower_components/angular-bootstrap/ui-bootstrap.js',
+  'src/bower_components/angular-bootstrap/ui-bootstrap-tpls.js',
+  'src/bower_components/angular-ui-router/release/angular-ui-router.js',
+];
+
+var styles = [
+  'src/bower_components/bootstrap/dist/css/bootstrap.css',
+  'src/bower_components/font-awesome/css/font-awesome.css',
+  'src/less/dashboard/variables.less',
+  'src/less/dashboard/mixins.less',
+  'src/less/dashboard/main.less',
+  'src/less/dashboard/loading.less',
+  'src/less/dashboard/content.less',
+  'src/less/dashboard/header.less',
+  'src/less/dashboard/sidebar.less',
+  'src/less/dashboard/widgets.less',
+  'src/less/dashboard/hamburg.less',
+];
+
+var fonts = [
+  'src/fonts/**.*',
+  'src/bower_components/bootstrap/dist/fonts/*.{ttf,woff,eof,svg}',
+  'src/bower_components/font-awesome/fonts/*.{ttf,woff,eof,svg}'
+];
 
 var paths = {
-  js: 'src/js/**/*.*',
-  fonts: 'src/fonts/**.*',
+  js: ['src/js/**/*.*', 'dist/js/templates.js'],
+  files: ['src/index.html'],
   images: 'src/img/**/*.*',
-  styles: 'src/less/**/*.less',
-  index: 'src/index.html',
-  bower_fonts: 'src/bower_components/**/*.{ttf,woff,eof,svg}',
-  bower_components: 'src/bower_components/**/*.*',
+  templates: 'src/templates/**/*.html',
+  fonts: fonts,
+  styles: styles,
+  vendors: vendors
 };
 
+// The name of the Angular module which will be injected into the templates.
+var moduleName = 'Dashboard';
 
-gulp.task('usemin', function() {
-  return gulp.src(paths.index)
-    .pipe(usemin({
-      less: ['concat', less()],
-      js: ['concat', wrap('(function(){ \n<%= contents %>\n})();')],
-    }))
-    .pipe(gulp.dest('dist/'));
+// Minify and copy all 3rd party libs to vendors.min.js 
+gulp.task('copy-vendors', function() {
+  return gulp.src(paths.vendors)
+    .pipe(uglify())
+    .pipe(concat('vendors.min.js'))
+    .pipe(gulp.dest('dist/js'));
 });
 
-/**
- * Copy assets
- */
-gulp.task('copy-assets', ['copy-images', 'copy-fonts', 'copy-bower_fonts']);
+// Minify and copy all dashboard script files to dashboard.min.js
+gulp.task('copy-scripts', function() {
+  return gulp.src(paths.js)
+    .pipe(uglify())
+    .pipe(concat('dashboard.min.js'))
+    .pipe(insert.prepend('\'use strict\';'))
+    .pipe(gulp.dest('dist/js'));
+});
 
+// Minify and copy all angular templates to templates.min.js
+gulp.task('copy-templates', function() {
+  return gulp.src(paths.templates)
+    .pipe(templates({module: moduleName}))
+    .pipe(uglify())
+    .pipe(concat('templates.min.js'))
+    .pipe(insert.prepend('\'use strict\';'))
+    .pipe(gulp.dest('dist/js'));
+});
+
+// Copy all static/HTML files to output directory
+gulp.task('copy-files', function(){
+  return gulp.src(paths.files)
+    .pipe(gulp.dest('dist'));
+});
+
+// Copy all images to output directory
 gulp.task('copy-images', function(){
   return gulp.src(paths.images)
     .pipe(gulp.dest('dist/img'));
 });
 
+// Copy all fonts to output directory
 gulp.task('copy-fonts', function(){
   return gulp.src(paths.fonts)
     .pipe(gulp.dest('dist/fonts'));
 });
 
-gulp.task('copy-bower_fonts', function(){
-  return gulp.src(paths.bower_fonts)
-    .pipe(gulp.dest('dist/lib'));
+// Compile less styles into dashboard.css
+gulp.task('compile-less', function(){
+  return gulp.src(paths.styles)
+      .pipe(less())
+      .pipe(cssmin())
+      .pipe(concat('dashboard.min.css'))
+      .pipe(gulp.dest('dist/css'));
 });
 
 /**
  * Watch src
  */
 gulp.task('watch', function () {
-  gulp.watch([paths.styles, paths.index, paths.js], ['usemin']);
-  gulp.watch([paths.images], ['copy-images']);
-  gulp.watch([paths.fonts], ['copy-fonts']);
-  gulp.watch([paths.bower_fonts], ['copy-bower_fonts']);
+  gulp.watch(paths.vendors, ['copy-vendors']);
+  gulp.watch(paths.js, ['copy-scripts']);
+  gulp.watch(paths.templates, ['copy-templates']);
+  gulp.watch(paths.files, ['copy-files']);
+  gulp.watch(paths.images, ['copy-images']);
+  gulp.watch(paths.fonts, ['copy-fonts']);
+  gulp.watch(paths.styles, ['compile-less']);
 });
 
 gulp.task('webserver', function() {
@@ -68,14 +130,5 @@ gulp.task('livereload', function() {
     .pipe(connect.reload());
 });
 
-/**
- * Compile less
- */
-gulp.task('compile-less', function(){
-  return gulp.src(paths.styles)
-      .pipe(less())
-      .pipe(gulp.dest('dist/css'));
-});
-
-gulp.task('build', ['usemin', 'copy-assets']);
+gulp.task('build', ['copy-vendors', 'copy-scripts', 'copy-templates', 'copy-files', 'copy-images', 'copy-fonts', 'compile-less']);
 gulp.task('default', ['build', 'webserver', 'livereload', 'watch']);
diff --git a/package.json b/package.json
@@ -2,19 +2,28 @@
   "name": "Responsive-Dashboard",
   "version": "0.0.2",
   "author": "Elliot Hesp",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Ehesp/Responsive-Dashboard"
+  },
   "contributors": [
     "Leonel Samayoa <[email protected]> (http://gobliip.com)",
-    "Ricardo Pascua <[email protected]>"
+    "Ricardo Pascua <[email protected]>",
+    "Mathew Goldsborough <[email protected]>"
   ],
   "scripts": {
     "postinstall": "node node_modules/bower/bin/bower install"
   },
   "devDependencies": {
     "bower": "^1.3.9",
     "gulp": "~3.8.0",
+    "gulp-angular-templates": "^0.0.1",
+    "gulp-concat": "^2.3.4",
     "gulp-connect": "^2.0.6",
+    "gulp-insert": "^0.4.0",
     "gulp-less": "~1.3.3",
-    "gulp-usemin": "^0.3.7",
+    "gulp-minify-css": "^0.3.7",
+    "gulp-uglify": "^1.0.0",
     "gulp-watch": "^0.6.9",
     "gulp-wrap": "^0.3.0"
   }
-Original file line number
+Diff line change
@@ Expand Up / @@ -41,3 +41,6 @@ Icon @@
     # Bower components
     /src/bower_components
+    # IDEA
+    /.idea