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.

In case you don't know what Yeoman is, it essentially like builds you out a "template" project or project skeleton. 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

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

yo eggs-genny

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

If it did work, then 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

• Bootstrap CSS
• Skeleton
• Lesslie

JS Frameworks/Tools

• jQuery
• Angular
• React
• GSAP

---

Documentation

If you want to know about the automated Gulp build process or development process, or the directory structure that eggs-genny produces, the best source are the docs.

You could also head over to the wiki which should make you laugh while answering all of your questions, although it's essentially the same as the docs.

---

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.