node package manager
Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

generator-frontcow

generator-frontcow Build Status

FrontCow is a Yeoman generator that initialize your front-end workflow in a minute!

What is FrontCow

Cute logo, big time saving... When it comes to make a website you have to set your workflow, prepare your libraries, your files structures. FrontCow handle all this to save your time, lunch it and go grab a coffee, when you'll be back, you're ready to work.

Composition

FrontCow uses some of the most used libraries to give you power and time saving.

Foundation 5

FrontCow use the amazing Foundation5 front-end framework powered by Zurb, which is "The most advanced responsive front-end framework in the world".

FontAwesome

FrontCow includes FontAwesome, the popular iconic webfont.

BrowserSync

FrontCow uses BrowserSync to build a simple static server highly customisable.

Atomic Design

FrontCow is developed with the Atomic Design architecture in mind, so it will create and organize your SCSS in a particulare file system:

├── app
│   ├── css
│   │   ├── main.css _(generated)_
│   │   └── main_override.css
│   ├── fonts
│   ├── js
│   ├── medias
│   │   ├── images
│   │   └── tmp
│   └── scss
│   │   ├── _your-project-name_
│   │   │   ├── quarks
│   │   │   ├── atoms
│   │   │   ├── molecules
│   │   │   ├── organisms
│   │   │   ├── templates
│   │   │   ├── pages
│   │   │   ├── utilites
│   │   │   └── _imports.scss
│   │   ├── _foundation-settings.scss _(foundation custom settings)_
│   │   ├── __your-project-name_.scss
│   │   └── main.scss
│   └── index.html
├── dist
├── .editorconfig
├── .gitignore
├── .jshintrc
├── LICENSE
└── package.json

Features

Available Scaffolding Options:

Included by default:

  • Template inspiration from HTML5 Boilerplate
  • Feature detection with Modernizr
  • JavaScript Linting with JSHint
  • Built in preview server with BrowserSync
  • .editorconfig for consistent coding styles within text editors
  • Automatic build process that includes concatenation, image optimization, CSS and HTML minification, and JS uglification.
  • Sourcemaps for JavaScript and either SCSS.

Getting Started

What is Yeoman?

Trick question. It's not a thing. It's this guy:

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.

Not every new computer comes with a Yeoman pre-installed. He lives in the npm package repository. You only have to ask for him once, then he packs up and moves into your hard drive. Make sure you clean up, he likes new and shiny things.

$ npm install -g yo

Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

  1. Install generato-frontcow form npm, run:
    $ npm install -g generator-frontcow
  2. Initiate the generator, run:
    $ yo frontcow
  3. Import bower libraries, run:
    $ bower install

FrontCow Grunt Tasks

The gruntfile provide a complete set of tools to help you to do your work.

Development

Grunt task starts the workflow with SASS watch & build, create a server and open your default browser to be ready to work.

Start the server

To start the server, just run the following command:

$ grunt server

To just build the dist files, run the following command:

$ grunt build

Javascript validation

To run the jsHint, just run the following command:

$ grunt scan-js

Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, Grunt and Bower, check out the complete Getting Started Guide.

License

MIT