https://github.com/patricknelson/sassified-sprites

Generic boilerplate used for building SASS and compiling sprites. Feel free to change this to suit your needs!
https://github.com/patricknelson/sassified-sprites

Last synced: 25 days ago
JSON representation

Generic boilerplate used for building SASS and compiling sprites. Feel free to change this to suit your needs!

• Host: GitHub
• URL: https://github.com/patricknelson/sassified-sprites
• Owner: patricknelson
• License: mit
• Created: 2015-08-10T15:36:34.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-10T19:35:23.000Z (about 9 years ago)
• Last Synced: 2024-05-17T00:19:11.760Z (6 months ago)
• Language: CSS
• Size: 141 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sassified-sprites

Generic boilerplate used for building SASS and compiling sprites. This is intended to stay pretty simple, so feel free to copy, modify and change this to suit your needs.

## Usage:

* `grunt build-sprites`

	* Generates sprites and minifies/optmizes the resulting sprites.png output file. Will also generate a _sprites.scss file which can be integrated into your SCSS project.

* `grunt build`

	* Generates all sprites and compiles SASS/SCSS down to CSS.

* `grunt dev`

	* Same as "build" above but also waits for more changes and regenerates all dynamic files when changes occur.

## Features

* Boilerplate for compiling SASS/SCSS files to CSS.

* Automatically generates and minifies PNG sprites, including easy to use accompanying SASS `%sprite-imagename` placeholders.

* Includes a the grunt [PostCSS](https://github.com/nDmitry/grunt-postcss) task with the [autoprefixer-core](https://github.com/postcss/autoprefixer-core) plugin for better browser backward compatibility.

## System Requirements

* [ruby](https://www.ruby-lang.org/) v1.9+

    * [bundler](http://bundler.io/): Manages ruby packages (gems) `gem install bundler`

    * Make sure RubyGems is up-to-date: `gem update --system`

* [node.js](http://nodejs.org/)

    * [npm](https://npmjs.org/): Manages node.js packages `npm update -g npm`

    * [grunt cli](http://gruntjs.com/): Task runner `npm install -g grunt-cli`

    * [bower](http://bower.io/): Manages css and javascript packages `npm install -g bower`

## Installation

First, see above to make sure you've got the right system requirements. Then, run the following commands:

```bash

# Installs ruby gems (sass, compass).

bundle install

# Install node.js packages (grunt tasks like watch and imagine for sprites/minification)

npm install

# Get started with development!

grunt dev

```

## Configuration

You can configure file paths at the top of the provided `Gruntfile.js`. The following paths are available by default:

* `css`

	* Where generated CSS is stored. By default, only `main.css` will end up here.

* `scss`

	*  Source directory where your SASS/SCSS will live. Any *.scss files (not starting with an underscore) will be converted to CSS files living in the above `css` directory, if placed here.

*  `images/sprites/src`

	*  Store any small image files which should be combined into a single sprite in this directory.

*  `images/sprites/build`

	*  Where the final generated sprite image file (`sprites.png`) will be placed.  

## To Do

* Setup a demo.html file.