Project Kit

A boilerplate web project with the following batteries:

• Babel - JavaScript ES2015 compiler
• SASS - CSS with superpowers
• Compass - CSS Authoring Framework using SASS
• Foundation - Responsive front-end framework
• Bower - Frontend dependency manager
• npm - Node package manager
• Grunt - Task runner
• Browserify - Modular JavaScript bundler
  • Remapify - Alias directories for browserify
• Livereload & Chrome Plugin & Firefox Plugin - Refresh HTML, CSS, JS, images and other stuff as soon as they change
• jQuery - JavaScript general purpose library
• Polymer - Make fast, beautiful, and interoperable web components
• Underscore - JavaScript functional library
• Backbone - Structure for JS applications

Installation

Install system dependencies:

• Node and npm with the global packages:
  • Grunt CLI
  • Bower
• Ruby with the gems:
  • SASS
  • Compass

Project dependencies:

npm install
bower install

Project configuration:

npm run configure

Most project dependencies are needed in the development environment. In a production environment they are not required because assets would have been created.

Anatomy

• src/ - Main source code
  • js/ - ES2015 code
  • scss/ - SASS code
  • polymers/ - Polymer components
• build/ - Build folder
• assets/ - Public assets folder
  • js/ - JavaScript assets
  • css/ - CSS assets
  • polymers/ - Compiled web components
• tests/ - Test suites
  • unit/ - Unit testing
  • integration/ - Integration testing
  • benchmarks/ - Benchmarks
  • index.js - Testing entry point
• tasks/ - Grunt tasks
  • index.js - Tasks entry point
• package.json - Node package info
• bower.json - Bower dependencies
• Gruntfile.js - Grunt file for tasks
• configure.js - Project configuration file
• .bowerrc - Bower config file
• .editorconfig - EditorConfig
• .jshintrc - JSHint config file
• .travis.yml - Travis CI Test and deploy code in the cloud
• app.js - express server example

License

MIT