ritenv / ng-seed

A super-heroic AngularJS seed base

                                |
,---.,---.   ,---.,---.,---.,---|
|   ||   |---`---.|---'|---'|   |
`   '`---|   `---'`---'`---'`---'
     `---'                       

About

ng-seed is a super-heroic AngularJS seed base. It is scaffolded with an awesome stack of tools that kickstart the dev process, and keep the journey pleasant. The power of Sass, benefits of gulp, flexibility of mocha, pros of RequireJS and known utility of AngularJS make this a complete seed for scalable, standard application architecture.

ng-seed includes:

• Application
  • RequireJS - Dependency Injections for JavaScript
  • Sass - CSS extension language
  • Bourbon - Mixin library for Sass
  • Neat - Grid framework for Sass and Bourbon
  • Bitters - Scaffold styles for Bourbon projects
  • Refills - Prepackaged patterns built on top of Bourbon
  • Bower - Front-end package manager
  • Gulp - Streaming build system
• Testing
  • angular-mocks - Mocks for AngularJS
  • Karma - JavaScript unit test runner
  • Mocha - Testing framework
  • Chai - Super-flexible assertion library
  • Protractor - End-to-end test runner
  • Istanbul - Coverage report generator

Instructions:

Getting started

• Install bower using sudo npm install bower -g.
• Install gulp using sudo npm install gulp -g.
• Run: npm start.
• Install Java from here, if prompted: http://support.apple.com/kb/DL1572 (to run Selenium)

The app consists of prestart and postinstall scripts that will ensure installation of npm dependencies and bower components. No need to install manually.

Other commands

• Run gulp to compile, minify, lint and test front-end assets.
• Run gulp debug default while you are developing so that you can use the unminified version of your assets.
• Run gulp server or gulp debug server if you want the default task run and your files served by a development HTTP server (includes livereload)
• Run gulp test to execute a single run of tests.

Travis

This repo is linked with Travis CI for build testing.