https://github.com/joakin/agruntemplate

https://github.com/joakin/agruntemplate

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/joakin/agruntemplate
• Owner: joakin
• Created: 2013-06-17T09:50:37.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2013-06-17T09:59:24.000Z (almost 13 years ago)
• Last Synced: 2025-02-18T19:55:29.231Z (over 1 year ago)
• Language: JavaScript
• Size: 168 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          

Grunt template

==============

This is a personal fairly complete grunt template for personal use. It features:

* CSS with Stylus and the Axis lib.

* JS with browserify for *CommonJS* style modules on the browser.

  * Coffeescript files are compiled automatically

  * Livescript files are compiled automatically

  * Handlebars templates are compiled automatically

* JSHint JS validations, via local `.jshintrc` file.

* Static website generation from Handlebars templates, markdown files, and data

  from JSON or YML files.

* Preview server.

* Watch task to autoexec all the previous tasks and the ability to use

  livereload on the browser.

Usage

-----

### Dependencies

You must have installed [npm](http://npmjs.org) and

[grunt](http://gruntjs.org).

### Download

Clone the template and remove the repo info:

    git clone https://github.com/joakin/agruntemplate.git

    mv agruntemplate my_super_secret_project

    cd my_super_secret_project

    rm -rf .git

    git init

    npm install

And to develop!

### Compile

The default task handles all compiling:

    grunt

or

    grunt default

### Preview server

You can get a preview server up on port 9001 by default by doing: (it will

compile and run the server)

    grunt preview

### Watch and livereload

Then, with the server running, you may want to speed up development

autoexecuting the tasks when the files change and connecting the browser to the

livereload server. For that, just do (on another terminal, leave the server

running):

    grunt watch

That is all!