https://github.com/swashcap/sample-gruntfile

A sample Grunt task file.
https://github.com/swashcap/sample-gruntfile

Last synced: 5 days ago
JSON representation

A sample Grunt task file.

• Host: GitHub
• URL: https://github.com/swashcap/sample-gruntfile
• Owner: swashcap
• Created: 2014-06-21T18:42:02.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-06-21T21:04:20.000Z (over 10 years ago)
• Last Synced: 2023-04-01T03:29:02.432Z (over 1 year ago)
• Language: JavaScript
• Size: 145 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Sample Gruntfile

This is a sample Grunt task. All the action is in _Gruntfile.js_; [check it out](https://github.com/swashcap/sample-gruntfile/blob/master/Gruntfile.js)!

## Tasks

There are three sample tasks in this project centered around files:

* **Styles:** Process Sass files and add vendor prefixes. Do this by running `grunt styles` from project root.

* **Scripts:** Lint JavaScript files and minify them. Do this by running `grunt scripts` from the project root.

* **Images:** Minify and optimize images. Do this by running `grunt imagemin` from the project root.

Development speed can be increased by **watching** files for changes and running the appropriate task. For simplicity, this only works styles and scripts. Do this by running `grunt watch` from the project root.

## Setup

Running these sample tasks requires some setup. Here’s what you’ll need:

* **[Sass](http://sass-lang.com):** a “CSS preprocessor” that extends regular ol’ CSS with some goodies

* **[Grunt](http://gruntjs.com):** a command line “task runner” that makes building and deployment easy

### Installing Sass

1. You need to have [Ruby running on your machine](https://www.ruby-lang.org/en/downloads/) (most systems come with it pre-installed).

2. Open a [shell window](http://en.wikipedia.org/wiki/Shell_(computing)) and run `gem install sass`.

Refer to Sass’s official [Installation guide](http://sass-lang.com/install) for additional assistance.

### Getting Grunt Up and Running

1. Grunt runs on [Node.js](http://nodejs.org/). [Download and install Node.js](http://nodejs.org/download/).

2. To install Grunt, open a shell window and run `npm install -g grunt-cli`.

3. To install Grunt’s dependencies (required little sub-programs), navigate to this project’s root folder in a shell window and run `npm install`.

Refer to Grunt’s official [Getting Started guide](http://gruntjs.com/getting-started) for additional assistance.