Psykoral / grunt-starter-kit

FlippyUI - grunt-starter-kit

Build Status:

• master:

Project template built from FlippyUI. grunt-starter-kit includes:

• A Git Clone from FlippyUI grunt-starter-kit
• Project specific Grunt runner.
• bower.json and package.json for common dependencies.
• AMD Javascript sources specific to grunt-starter-kit.
• Reference Design Library: http://flippydisk.com/

Local Development

Prerequisites

• Install Git

• Install NodeJS >=4

• Install Grunt ~1.0.1

    npm install -g grunt-cli
  

• Install Bower

    npm install -g bower
  

• Install PhantomJS

    npm install -g phantomjs-prebuilt
  

Running grunt-starter-kit

• Clone grunt-starter-kit

  git clone https://github.com/Psykoral/grunt-starter-kit.git

• Run all NPM and Bower items

  ./update.sh

  • Windows users run this with GitBash.exe
  • *nix & Mac users you might need to chmod +x this file to allow it to be executable.

• grunt live

  • Runs the Example site

• grunt jsdoc

  • Runs JSDoc API documentation
  • Run after 'grunt live', keep that server running then go to http://localhost/jsdoc/

• grunt test

  • Runs Jasmine tests in the console (also runs on 'grunt live')

• grunt livetests

  • Runs Jasmine tests in a browser

Distribution Package

The distribution package is the end result of building this project:

dist/
├── css/
   ├── grunt-starter-kit.css
├── js/
   ├── grunt-starter-kit.js

Community

Want to use FlippyUI? See our Contributing documentation.

Developed under the MIT License.