https://github.com/miguelsolorio/grunt-bourbon-neat-boilerplate

A front-end boilerplate that uses Grunt + Bourbon Neat
https://github.com/miguelsolorio/grunt-bourbon-neat-boilerplate

boilerplate bourbon-neat grunt

Last synced: 17 days ago
JSON representation

A front-end boilerplate that uses Grunt + Bourbon Neat

• Host: GitHub
• URL: https://github.com/miguelsolorio/grunt-bourbon-neat-boilerplate
• Owner: miguelsolorio
• Created: 2018-01-09T18:05:08.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-30T17:40:28.000Z (over 6 years ago)
• Last Synced: 2025-01-03T13:38:47.055Z (21 days ago)
• Topics: boilerplate, bourbon-neat, grunt
• Language: JavaScript
• Homepage:
• Size: 588 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# grunt-bourbon-neat-boilerplate

This boilerplate runs on [Grunt](http://gruntjs.com/) and [Bower](http://bower.io/), which depend on [Node](http://nodejs.org/) and [npm](http://npmjs.org/). Ensure that you have Node and npm installed before you begin. Additionally, this project utilizes the following libraries:

- [Assemble](http://assemble.io/)

- [Bourbon](http://bourbon.io/)

- [Neat](http://neat.bourbon.io/)

- [RequireJS](http://requirejs.org/)

- [Modernizr](http://modernizr.com/)

- [jQuery](http://jquery.com/)

## Dependencies

### Installing Grunt

1. Change to the project's root directory.

2. Install the CLI by running: npm install -g grunt-cli

3. Install project dependencies with: npm install.

4. Run Grunt with: grunt.

5. For more details, visit [Grunt's website](http://gruntjs.com/getting-started).

### Installing Bower

1. Install Bower globally using npm: npm install -g bower

2. Install project dependencies with: bower install.

3. For more details, visit [Bower's website](http://bower.io/).

## File Structure

### HTML

All pages can be found under src > template > pages which use the default layout template found under src > template > layouts > default.hbs.

You can also find all partials under src > template > partials > *.hbs.

### SASS

All CSS dependencies are imported at src > css > main.scss.

### JavaScript

RequireJS handles all dependencies and are defined at src > js > config.js and included at src > js > app.js.

## Build

### Grunt

The default grunt tasks will start the development build and will watch your files for updates.

### Grunt Build

When you're ready to build for production simply run: grunt build and your files will be minified under the _public directory.