README.md

Welcome!

This structure was created for js-modules according to some standards of pattern.

##Problem: We last years working in some companies, realizes the difficulty of having several projects from the same client. Especially when the project has the following structure:

public
	|_site 
	|	|css/
	|  	|js/
	|  	|-index.html
	|_landpage
	|	|css/
	|	|js/
	|	|-index.html
	|
	|_dashboard
		|css/
		|js/
		|-index.html

I realized that over the project gruntfile was totally bad to understand or with various gruntfile for each project. My idea was to create a grunt where no matter what project you are working have to use only one gruntfile.

##Solution:

This structure / pattern  

	Client
		|_configProject
		|		|
		|		|taskGrunt.js
		|
		|__content
		|	|core
		|	|	|0.soma-template-v0.3.2
		|	|	|1.core.js
		|	|modules
		|	|	|MODULE_Forms.js
		|	|
		|	|libs
		|	|	|jquey.js
		|	|
		|	|
		|	|
		|	|spec
		|	|	|MODULE_FormsSpec.js
		|	|
		|	|_config.json
		|	
		|projects
		|	|site
		|	|	|controller
		|	|	|	|controller_Forms_site.js
		|	|	|		
		|	|	|styles
		|	|	|	|sass
		|	|	|	|reset.css
		|	|	|		|scss
		|	|	|			|reset.scss
		|	|	|			|
		|	|	|__views
		|	|		|
		|	|		|site
		|	|		|	|data
		|	|		|	|	|data.json
		|	|		|	|modules
		|	|		|	|	|headerTop.hbs
		|	|		|	|	|footer.hbs	
		|	|		|	|	|**.hbs
		|	|		|	|	
		|	|		|	|index.hbs
		|	|		|	
		|	|
		|	dashboard
		|		|controller
		|		|	|controller_Forms_painel.js
		|		|
		|		|styles
		|		|	|css
		|		|		|reset.css
		|		|
		|		|views
		|			|dashboard	
		|				|data
		|				|	|data.json
		|				|modules
		|				|	|headerTop.hbs
		|				|	|footer.hbs	
		|				|	|**.hbs
		|				|	
		|				|index.hbs
		|	
		|__public
		|	|site
		|	|	|css/general-min-un.css
		|	|	|js/general-min-un.js	
		|	|	|img/**.[png,jpg,gif]
		|	|	|-index.html
		|	|
		|	|dashboard
		|	|	|css/general-min-un.css
		|	|	|js/general-min-un.js	
		|	|	|img/**.[png,jpg,gif]
		|	|	|-index.html
		|
		|___|tasks
		|	|	|lib
		|	|	|	|yui-compressor.js
		|	|	|	
		|	|	|plato.js
		|	|	|template_html.js
		|	|	|yui-compressor.js
		|	|
		|	|
		|
		|
		|.gitignore
		|.jshintrc
		|Gruntfile.js
		|package.json
		|README.md

##Config

{
    "site":[
        {
        	"plugins":{
        		"jquery":true,
        	},
            "module":{
            	"Forms": true
            },
            "styles": {
	        	"sass" : {
	        		"reset":true,
	        		"menu" :true
	        	},
	        	"css": {
	        		"reset" :  true,
	        		"menu":true,
	        		"contato":true
	        	}

		    },
		    "default":{
		    	"debug":false,
		    	"build"  : "./public/www/"
		    }

        }
    ],
  	
    "dashboard":[
   		{
            "module":{
            	"Forms": true
            },
            "styles": {
	        	"sass" : {
	        		"reset":true,
	        		"menu" :true
	        	}

		    },
		    "default":{
			    "debug":false,
			    "build" : "./public/dashboard/"
			}
        }
    ]
}		

*To start a new project you must follow the steps below.

Dependencies

*if you don't have it yet.

1. Install Git
2. Install NodeJS
3. Install [Ruby-Sass] (http://sass-lang.com/install)

Setup

1. Open your terminal and clone the project.

   $ git clone https://github.com/jaffarc/Patterns-Grunt-Project
   

2. Then go to the project's folder.

   cd Patterns-Grunt-Project
   

3. Install local dependencies, If you are a problem, installing the dependence manually remembering that some have to be the version that is in package.json.

   npm install   ||  npm install <name>@<version>
   

Usage

Once installed all the dependencies, run via terminal: grunt help It will shows the desk already configured and running.

All the modules should have the test spec.

The compress order the modules are in order to put in config.json the same goes for the css or sass.

##References:
Book: JavaScript Patterns. Book: javascript the definitive guide, 6h edition. Book: High Performance JavaScript.

Just have fun. Go ahead and edit the code or add new files. This was a study!

License

[MIT License] © Jaffar Cardoso