generator-prototype

Visit the PG-website to learn how to use PG: http://prototype-generator.com

Yeoman generator for Prototype

Getting started

Requirements

• Node.js & Node Package Manager
• Grunt Command Line Interface – npm install -g grunt-cli

Optional Use of Ruby (SASS & Compass)

• SASS 3.4 (only when you do not want to use node-sass) – gem install sass
• Compass 1 (because of Source Maps) – gem install compass --pre

Installation

• Install Yeoman: npm install -g yo

• Install the Generator-Prototype via: npm install -g generator-prototype

Update

• Update the Generator-Prototype via: npm update -g generator-prototype

Usage

Scaffold your new prototype project.

yo prototype

Options

• -s alias --skip-install

  Skips the automatic execution of bower and npm after scaffolding has finished.

Quick Start

You can scaffold your project in an instance. The first question is:

"Choose your installation routine"

If you choose Minimal installation you skip the rest of the questions and get the default values with:

• Libsass (grunt-sass)
• Grunt Modules: grunt-grunticon, grunt-data-separator
• Assemble as Template Engine

Structure

├───helpers
│   ├───configs
│   ├───templates
│   │   ├───grunticon-template
│   │   └───styleguide-template
│   └───_grunt
├───resources
│   ├───ajax
│   ├───assets
│   │   ├───fonts
│   │   ├───img
│   │   │   ├───svg
│   │   │   │   └───icons
│   │   └───media
│   ├───bower-components
│   ├───data
│   ├───js
│   ├───scss
│   │   ├───global
│   │   ├───icons
│   │   └───utils
│   │       ├───extends
│   │       └───mixins
│   └───templates
│       ├───helpers
│       ├───layouts
│       ├───pages
│       └───partials
├───_dist
└───_output

Plugins and Modules

There are standard grunt modules I use. These are:

• grunt-contrib-clean - Clean your directories.
• grunt-concurrent - Run grunt tasks concurrently .
• grunt-contrib-cssmin - Minify your CSS.
• grunt-htmlhint - Check your html for errors.
• grunt-contrib-jshint - Check your js for errors.
• grunt-jsbeautifier - Format your js and html files.
• grunt-combine-media-queries - When you use mixins for media queries in your SASS files, you can combine your media queries with this module
• jit-grunt - A JIT(Just In Time) plugin loader for Grunt.
• time-grunt - Displays the execution time of grunt tasks.

Grunt modules

But you can also apply additional addons and grunt modules to your project. Just choose specific ones:

• grunt-autoprefixer - Autoprefixer parses CSS and adds vendor-prefixed CSS properties using the Can I Use database.
• grunt-bless - Split your css after you reach size limit for ie9
• grunt-browser-sync - Sync and auto-reload your local server over multiple devices
• grunt-comment-media-queries - You begin your project with mobile first but need to support desktop styles in IE8? That's your module! (see Features)
• grunt-comment-toggler - Toggle comments inside build blocks.
• grunt-connect-proxy - a preconfigured proxy for developing clientside API interfaces in your prototype, with CORS, Basic Authentication support and http methods
• grunt-contrib-compass - Come on, use Node-SASS ...
• grunt-contrib-htmlmin - Minify your HTML files.
• grunt-contrib-requirejs - Optimize RequireJS projects using r.js.
• grunt-contrib-uglify - Minify files with UglifyJS.
• grunt-csscomb - The grunt plugin for sorting CSS properties in specific order.
• grunt-devtools - An user interface in chrome to execute grunt tasks in your project
• grunt-data-separator - Split up your Data-URI into a separate CSS file.
• grunt-dr-svg-sprites - Generate SVG Sprites with scss files (we use an own fork to support placeholders in scss)
• grunt-grunticon - Generate SVG-URI-SASS files with png fallbacks
• grunt-jsdoc - This plugin enables you to integrate the generation of comments based documentation into your Grunt build.
• grunt-modernizr - grunt-modernizr sifts through your project files, gathers up your references to Modernizr tests and outputs a lean, mean Modernizr machine.
• grunt-packager (only executable when your project.jspackcfg is configured) - package your js.
• grunt-phantomas - PhantomJS-based web performance metrics collector and monitoring tool.
• grunt-photobox - Take snapshots from homepage
• grunt-responsive-images - Produces images at different sizes (be sure you have installed GraphicsMagick)
• grunt-sass - You want to use Libsass instead of Compass to render your stylesheets 10 times faster? Here you go! (see Features)
• grunt-svgmin - Minify SVG using SVGO.
• grunt-version - Grunt task to handle versioning of a project.

Assemble

We use Assemble as template engine. Assemble is a component and static site generator that makes it dead simple to build modular sites, documentation and components from reusable templates and data. You want to know more? Here you go: assemble.io

In your installation routine you can choose specific modules for Assemble:

• assemble-contrib-permalinks
• assemble-contrib-sitemap
• assemble-related-pages

Custom Helpers

We provide some custom helpers to speed up your prototyping. These helpers provide:

• repeating elements
• limiting JSON output
• partials with multiple contexts
• factories for grid systems
• and a few more ...

You want to know more? See PG Custom Helpers

Gruntfile

For our Gruntfile we use the grunt module load-grunt-configs to split up the file in multiple task files. You can find these task files in the following directory:

• helpers/_grunt

Features

PG supports different features. Just check/uncheck them in the custom installation routine:

• You want to add a separate distribution folder? - Check!
• You want to add a CSS Styleguide and Assemble Development Documenation? - Check! (See "Developer Documentation")
• You want to use Libsass instead of Ruby to compile SASS files? - Check!
• You want to use PG Methodology? - Check!
• You begin your project with mobile first but need to support desktop styles in IE8? - Check!

JS Libraries and CSS Frameworks

You can choose JS Libraries like:

• jQuery
• BackboneJS
• RequireJS
• AngularJS

And you can also choose SCSS Frameworks like:

• Foundation
• Bourbon Neat
• SASS Bootstrap

All files will be included and configured. Have fun!

Sub Generators

We integrated some sub generators for you:

Grunt Modules:

You forgot a grunt module?

• Install your grunt modules: yo prototype:grunt

Assemble Helpers:

You want to install assemble helpers?

• Here you go: yo prototype:assemble

Frontend Components:

You want to install all base templates, a form template or other modules? (work in progress)

• Here you go: yo prototype:components

BackboneJS:

• Create a Backbone Model: yo prototype:bm
• Create a Backbone View: yo prototype:bv
• Create a Backbone Collection: `yo prototype:bc

Others will follow.

Developer Documentation

PG provides a way to document your assemble modules via markdown and a separate docs folder. Just use the custom installation route and check:

• Create Developer Documentation

For further informations and instructions see:

• assemble-documentation-example

Alternative

• grunt-init-assemble
• generator-assemble

License

MIT License

Release History

v0.4.70

• added travis ci
• changed prototype:gm => prototype:grunt
• added prototype:assemble for helper files

v0.4.69

• grunt-jsdoc@beta added with custom configs
• prototype:gm => added grunt-jsdoc, grunt-contrib-requirejs, grunt-comment-toggler
• Refactored index.js to prepare PG for Gulp support

v0.4.68

• Split custom partial helper and factory helper
• Added possibility to extend options in Assemble to activate factories

v0.4.67

• Added grunt-comment-toggler for RequireJS
• Changed components/c-article.hbs

v0.4.65

General

• Refactored Gruntfile.js
• Added loadCSS.js to load CSS Styles asynchronous

Assemble

• Added custom helper-partial.js
• Added support for assemble factories
• Added Regions Readme.md

SASS

• Added custom breakpoint mixin

v0.4.64

• Fixed bug with version block
• Fixed async task
• Added c-form.scss

v0.4.63

• Added Regions for PG Frontend Methodology
• Modified form component
• Deleted batch files
• Refactored bower directory in demo files
• Added almond and grunt-contrib-requirejs

v0.4.62

• Optimized package.json
• Integrated git submodule for components
• Integrated {{#ifBlock}} helper

v0.4.61

• Minor change in svg-sprites task
• Bugfix with version.js
• Mixin: spriteicon() added
• Updated prototype:gm to support automated download of grunt-text-replace
• Changed path for prototype:plugin

v0.4.60

• Updated grunt-photobox to support grunt-browser-sync or grunt-contrib-connect
• Changed output of photobox to Dev folder

v0.4.59

• Changed Standard Installation to Minimal Installation
• Optimized svg-sprites and svgmin workflow
• Changed classes fo PG Frontend Methodology

v0.4.58

• Added fork of grunt-dr-svg-sprites and dr-svg-sprites to support placeholders in scss files
• Changed replace.js to change file path
• Added PG Frontend Methodology

TODO:

• Tests
• Integrate Broccoli.js as option