Package Exports

generator-eggs-genny

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (generator-eggs-genny) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Welcome to eggs-genny

Dumb name, great generator.

eggs-genny is a robust webapp-building Yeoman generator. The terriblly punny name comes from this line that I wrote when I initialized the repo:

An EGGS-ellent Yeoman GENNY-erator for building modern web apps.

Simulated animation of using eggs-genny

In case you don't know what Yeoman is, it essentially like builds you out a "template" project or project skeleton. It can also do other cool stuff like installing dependencies for you. It's fucking dope, saves you a shit load of time, and there are literally a bunch of prebuilt ones. You can also write your own, obviously, which is how eggs-genny was born.

To learn all about Yeoman and how to get up and running with eggs-genny, take a look at the (hilarious and thorough) wiki.

Quick Install

This presumes you've installed a Yeoman generator before. If not, check out the wiki. eggs-genny is on npm, so installing it is a breeze:

npm install -g generator-eggs-genny

If that didn't work try running it with sudo in front of the command.

Now just cd into your little rag-tag project and run:

yo eggs-genny

This is where shit gets real. Answer some questions and in no time you'll have a web app with you name on it, customized to exactly how you like it.

You can also optionally skip the bower and npm installs by adding --skip-install to the end of the command, like so:

yo eggs-genny --skip-install

Options Overview

eggs-genny gives you a lot of options to customize your project's setup. It starts by asking some proceedurial stuff, such as the name and description of your application. eggs-genny is always growing, but as of writing this here are the options that eggs-genny provides to customize what your project will use:

Preprocessors

Less
Sass

CSS Frameworks/Tools

JS Frameworks/Tools

In addition, you will be prompted about whether or not you would like to use CoffeeScript, as well as what GSAP plugins you need if you are using GSAP.

You will also be asked if you use Sublime Text, because if you do eggs-genny is going to hook you up with a sweet project file to get you started.

Another prompt you will be met with is whether or not you would like eggs-genny to add & link up some default Apple touch icons for you to use, as well as Windows 10 tile icons.

Contribute

Wanna help a brother out? Feel free to make suggestions here or on Twitter, or better yet create a pull request and help build eggs-genny!

Created by Dave Lunny in the beautiful year 2015.