Generator-meanie NPM

generator-meanie

MEAN stack generator for Yeoman with gulp. Follows the Best Practice Recommendations for Angular App Structure, and, in general, attempts to follow best practices throughout.

What this is

Modular: The main goal of this generator is to create a highly componentized file structure for both front-end and server-side code. This helps to keep your code modular, scalable, and easier to understand.
Gulp tasks: This includes a wide array of gulp tasks for optimizing front-end performance and streamlining your development process.
App infrastructure: This creates a comprehensive boilerplate infrastructure for a end-to-end web application using the MEAN stack. This likely includes some extra bells and whistles that you may not want to include in your particular app. The goal of this project is to promote development through subtractive synthesis. What this means is that, hopefully, this generator creates infrastructure that will handle most of the high-level problems in your web app, in addition to providing some other common features that you will likely remove.
Tests: This includes a testing infrastructure using the Karma test runner and the Jasmine test framework for testing the front-end code.
SASS: This uses the SASS style sheet language.
UI-Router: This uses the UI-Router library for more powerful front-end routing and state management in Angular.

Why use this generator instead of one of the many other options?

Maybe you shouldn't! Check out the file structure, the gulp tasks, and the various libraries and tools that are used in this project. If these are all aspects that you agree with, then please try this generator out! Otherwise, there are many other great generators out there for you to use. Addy Osmani has an excellent article describing MEAN-stack development and a quick survey of some of the more popular generators and boilerplate options for it. Each of these options have different benefits and each option uses a different set of tools.

How to use it

npm install -g generator-meanie
yo meanie

See the getting set up guide for a step-by-step walkthrough for setting things up and running.

Technology stack / acknowledgements

This project uses technology from a number of third-parties. These technologies include:

Node.js
AngularJS
MongoDB
gulp.js
SASS
Yeoman
Git
Numerous other packages that are available via NPM (these are listed within the package.json file)
Numerous other packages that are available via Bower (these are listed within the bower.json file)

Background

This project is an on-going effort to collect common patterns and processes for developing web apps using the MEAN stack and gulp. It is constantly evolving and gaining new features.

The contents of this project is strongly opinionated. This is all code that was originally developed and tested by Levi for his own personal use. That being said, it works great for him, so it will probably work great for you too!

Feedback, bug reports, feature requests, and pull requests are very welcome!