marccloud / angularify-seed

Angular + Broserify implementation seed project.

Angular Single Page Application Seed

History

Every time you start a new project the most boring and time consuming task is the set up. Define folder structure, libraries to use, build tool, test suit, version control, etc.

This seed project contains the essential set up for an angular + browserify project, and works on top of NodeJS based tools.

Tools Used

• Gulp : Main automation and local build tool. Compiles templates, runs units test, concatenate javascript and css files, among other things.
• Mocha : Unit testing framework. It has great flexibility, is compatible between browser and server and has a good set of assertion and mock libraries Chai & Sinon.
• Browserify : Node module that allows the usage of CommonJS modules in the browser.
• Plato : JavaScript source code complexity analyzer.
• Istanbul : JavaScript code coverage tool and reporter.
• JSHint : Code quality analyzer. Detects code smells and bad practices.
• Jade : Templating language to create re-usable HTML components.
• Sass : CSS preprocessor that helps us maintain our css assets.
• AngularJS : JavaScript Front-End framework to structure and fast develop web applications.
• Angular UI Router: Route and easily use nested views.
• Angular Bootstrap: Bootstrap directives, css and services for AngularJS.

Pre-requisites

• NodeJS installed in your development machine.
• Gulp and Bower installed. Install by running npm install -g gulp bower

How to Roll

Clone this repo and run npm install && bower install.

Run gulp <taskname> in your command line.

Available Tasks:

• Default : Compiles SCSS and Jade files, bundles JS code, runs unit tests and starts a web server on http://localhost:3000.Just run gulp
• CSS : gulp css. Compiles SCSS files to CSS.
• JS : gulp js. Bundles JavaScript code using Browserify.
• HTML: gulp html. Compiles jade templates to html files.
• Unit Test: gulp unit-test. Runs unit test suits using Mocha and Istanbul.
• Lint JS : gulp lint-js. Runs JSHin to detect code smells in your source files.
• Analyze: gulp analyze. Lints, unit test and checks complexity of source code.
• Serve: gulp serve. Starts HTTP server on http://localhost:3000.