<commit_before># generator-mean-seed

[Yeoman](http://yeoman.io) Generator for MEAN-seed - MongoDB, Express.js, AngularJS, Node.js + Yeoman (Grunt, Bower, Yo) + Jasmine, Karma, Protractor (for automated testing)


## Demo & Tests
- [MEAN-seed Website/App after Yeoman build](http://172.16.17.32:3000/)
- [Continuous Integration / Tests](http://172.16.17.32:3010/)
	- This automatically deploys and tests the yeoman generated mean-seed website on each Github push (from local development)
- [Github Repo with Generated Code](https://github.com/jackrabbitsgroup/mean-seed-gen)
	
	
	
## Getting Started

NOTE: This assumes you already have the necessary programs (i.e. Git, Node.js, MongoDB, PhantomJS) installed; see [here for Mac/Windows](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/docs/setup-server-windows-mac.md) or [here for Linux](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/docs/setup-server-linux.md)

Install Yeoman Yo, Bower, Grunt and other global node modules we'll need, if you don't have them already:
```
$ npm install -g yo bower grunt-cli jasmine-node karma yuidocjs forever less
```

Install this generator:
```
$ npm install -g generator-mean-seed
```

Naviagate to a (new) directory where you want to create your AngularJS and node.js app and initiate the generator then follow the prompts:
```
$ yo mean-seed
```

- NOTE: you can also (first) create a `yo-configs` folder with .json files for the prompts so you don't have to type them all out. This is useful for storing multiple different configurations for different projects - just tell the generator which config to use and you're all set! See the [yo_configs folder](https://github.com/jackrabbitsgroup/generator-mean-seed/tree/master/yo-configs) for examples.
- NOTE: if you get an EACCESS / permission denied error during the npm install, find the folder that had permissions issues (from the log output) and run `sudo chown -R $USER [path to problematic folder]`.
	- http://foohack.com/2010/08/intro-to-npm/#what_no_sudo

[See here](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/_README.md) for more/full info and steps.

### Next Steps
- See the generated README.md file in your new mean-seed app!



## (Sub)Generators List

- core-default
- core-scss
- ng-route

See the [docs/generators](docs/generators) folder for more info.

More generators coming - feel free to create one and submit a pull request!



## Documentation / More Info
See the [generated README.md](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/_README.md) file and the `docs` folder for all documentation. Each (sub)folder typically has an `overview.md` file - start there. Some key docs (roughly in order of priority) listed below:

- [overview.md](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/docs/overview.md)
- [setup-running folder](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/docs/setup-running/)
	- [setup-running/overview.md](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/docs/setup-running/overview.md)
- [tools-dependencies folder](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/docs/tools-dependencies/)
- [files folder](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/docs/files/)
- [testing-automation folder](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/docs/testing-automation/)
- [frontend-angular/common-actions.md](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/docs/frontend-angular/common-actions.md)
- [backend-node/common-actions.md](https://github.com/jackrabbitsgroup/generator-mean-seed/blob/master/core-default/templates/docs/backend-node/common-actions.md)


## Miscellaneous

### What is Yeoman?

If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).
<commit_msg>docs: readme update<commit_after># generator-mean-seed

[Yeoman](http://yeoman.io) Generator for MEAN-seed - MongoDB, Express.js, AngularJS, Node.js + Yeoman (Grunt, Bower, Yo) + Jasmine, Karma, Protractor (for automated testing)


## Demo & Tests
- [MEAN-seed Website/App after Yeoman build](http://172.16.17.32:3000/)
- [Continuous Integration / Tests](http://172.16.17.32:3010/)
	- This automatically deploys and tests the yeoman generated mean-seed website on each Github push (from local development)
- [Github Repo with Generated Code](https://github.com/jackrabbitsgroup/mean-seed-gen)
	
	
	
## Getting Started

NOTE: This assumes you already have the necessary programs (i.e. Git, Node.js, MongoDB, PhantomJS) installed; see [here for Mac/Windows](core-default/templates/docs/setup-server-windows-mac.md) or [here for Linux](core-default/templates/docs/setup-server-linux.md)

Install Yeoman Yo, Bower, Grunt and other global node modules we'll need, if you don't have them already:
```
$ npm install -g yo bower grunt-cli jasmine-node karma yuidocjs forever less
```

Install this generator:
```
$ npm install -g generator-mean-seed
```

Naviagate to a (new) directory where you want to create your AngularJS and node.js app and initiate the generator then follow the prompts:
```
$ yo mean-seed
```

- NOTE: you can also (first) create a `yo-configs` folder with .json files for the prompts so you don't have to type them all out. This is useful for storing multiple different configurations for different projects - just tell the generator which config to use and you're all set! See the [yo_configs folder](yo-configs) for examples.
- NOTE: if you get an EACCESS / permission denied error during the npm install, find the folder that had permissions issues (from the log output) and run `sudo chown -R $USER [path to problematic folder]`.
	- http://foohack.com/2010/08/intro-to-npm/#what_no_sudo

[See here](core-default/templates/_README.md) for more/full info and steps.

### Next Steps
- See the generated README.md file in your new mean-seed app!



## (Sub)Generators List

- core-default
- core-scss
- ng-route

See the [docs/generators](docs/generators) folder for more info.

More generators coming - feel free to create one and submit a pull request!



## Documentation / More Info
See the [generated README.md](core-default/templates/_README.md) file and the `docs` folder for all documentation. Each (sub)folder typically has an `overview.md` file - start there. Some key docs (roughly in order of priority) listed below:

- [overview.md](core-default/templates/docs/overview.md)
- [setup-running folder](core-default/templates/docs/setup-running/)
	- [setup-running/overview.md](core-default/templates/docs/setup-running/overview.md)
- [tools-dependencies folder](core-default/templates/docs/tools-dependencies/)
- [files folder](core-default/templates/docs/files/)
- [testing-automation folder](core-default/templates/docs/testing-automation/)
- [frontend-angular/common-actions.md](core-default/templates/docs/frontend-angular/common-actions.md)
- [backend-node/common-actions.md](core-default/templates/docs/backend-node/common-actions.md)


## Miscellaneous

### What is Yeoman?

If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).

{'fraction_non_alphanumeric': 0.12287480680061824, 'fraction_numerical': 0.00824317362184441, 'mean_word_length': 4.614605929139552, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 17, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 4, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3882630', 'n_tokens_mistral': 2460, 'n_tokens_neox': 2318, 'n_words': 692}