generator-prototype

Prototype Generator

Yeoman generator for Prototype.

Getting started

• Install Yeoman: npm install -g yo

• Install the package via: npm install -g generator-prototype

• Or copy the repository via clone to your directory (it depends on the system, just find your directory with yo installed): git clone https://github.com/Prototype-Group/generator-prototype.git ~/AppData/Roaming/npm/node_modules

Hints

Sometimes you need to clone the package with an absolute path. On windows the clone command can look like this: git clone https://github.com/Prototype-Group/generator-prototype.git D:\Users\Username\AppData\Roaming\npm\node_modules

• Replace 'Username' with your username

Usage

Prototype app scaffolds.

mkdir project && cd project
yo prototype [--skip-install]

Options

• -s alias --skip-install

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

• -w alias --skip-welcome-message

  Skips app welcome message.

Plugins and Modules

You can apply multiple addons and grunt modules to your project. Just choose specific ones:

Assemble

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

Grunt modules

• grunt-devtools - An user interface in chrome to execute grunt tasks in your project
• grunticon-sass - Generate SVG-URI-SASS files with png fallbacks
• dr-grunt-svg-sprites - Generate SVG Sprites with css files
• grunt-packager (only executable when your project.jspackcfg is configured) - package your js
• grunt-contrib-compass
• grunt-browser-sync - Sync and aut-reload your local server over multiple devices
• grunt-htmlhint - Check your html for errors
• grunt-prettysass - Format your SASS-files
• grunt-photobox - Take snapshots from homepage
• grunt-bless - Split your css after you reach size limit for ie9
• grunt-combine-media-queries - When you use mixins in your SASS files, you can combine your media queries with this module

CMS snippets (work in progress)

You can choose between multiple content management systems (Drupal, Typo3, Magnolia, CoreMedia). After choosing a system you will get HTML-snippets and a few new SCSS files, which you can use:

• Drupal 7
• TYPO3 6.2
• Magnolia
• CoreMedia

Alternative

• grunt-init-assemble
• generator-assemble

License

MIT License

TODO:

• CMS Snippets