<commit_before># Generator-Stamp
[![Build Status](https://secure.travis-ci.org/kyledetella/generator-stamp.png?branch=master)](https://travis-ci.org/kyledetella/generator-stamp)

## Stamp Generator
  A [Yeoman](http://yeoman.io) generator for scaffolding out a scalable web application.
  Quick Features:
  + A flyweight node.js server
  + [ZURB's Foundation](http://foundation.zurb.com)
  + Sane & scalable javascript architecture (AMD modules optional)
  + Optional inclusion of Backbone.js
  + Handlebars templates

## Requirements
  + [Node.js](http://nodejs.org)
  + [Compass](http://compass-style.org/)
  + [zurb-foundation gem](http://foundation.zurb.com/docs/sass.html)
  + [grunt-cli](http://gruntjs.com/getting-started)
    `npm install -g grunt-cli`
  + Yeoman [yo](https://github.com/yeoman/yo)
    `npm install -g yo`

## Getting started
  + Install the generator globally: `npm install -g generator-stamp`
  + Run: `yo stamp` (make sure to cd into the directory where you wish to run your app)
  + Finally, run: `grunt go` and start coding!

## Grunt Tasks
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins.

  + `grunt go` - This will fire up a node.js server, setup watch tasks, and open your browser pointed at your app
  + `grunt server` – This will spin up the node.js server (*note*, you may also fire up the node server via `node server`)
  + `grunt templates` – Will compile all `.hbs` files within `public/templates` into `templates.js` and will be accessible via
```js
  // If using AMD
  define(['templates'], function(templates) {
      // templates['template_name'];
  });
  
  // If not using AMD
  window.JST.['template_name'];
```
  + `grunt restart` – Restart all tasks intiated via `grunt go` except browser will not auto-open
  
## Your App
### Stamp will scaffold out you project with the following structure:

``` unicode
.
├── Gruntfile.js
├── config.rb
├── package.json
├── node_modules
│   ├── ...
├── public
│   ├── css
│   │   ├── app
│   │   │   └── app.css
│   │   └── scss
│   │       ├── _settings.scss
│   │       └── app.scss
│   ├── img
│   ├── index.html
│   ├── js
│   │   ├── lib
│   │   │   ├── backbone-min.js
│   │   │   ├── handlebars.js
│   │   │   ├── lodash.compat.min.js
│   │   │   ├── modernizr.min.js
│   │   │   ├── require.js
│   │   │   └── zepto.min.js
│   │   ├── main.js
│   │   └── templates
│   │       └── templates.js
│   └── templates
└── server.js

```

## License
[MIT License](http://en.wikipedia.org/wiki/MIT_License)
<commit_msg>README updates<commit_after># Generator-Stamp
[![Build Status](https://secure.travis-ci.org/kyledetella/generator-stamp.png?branch=master)](https://travis-ci.org/kyledetella/generator-stamp)

## Stamp Generator
  A [Yeoman](http://yeoman.io) generator for scaffolding out a scalable web application.  
  Quick Features:
  + A flyweight node.js server
  + [ZURB's Foundation](http://foundation.zurb.com)
  + Sane & scalable javascript architecture (AMD modules optional)
  + Optional inclusion of Backbone.js
  + Handlebars templates

## Requirements
  + [Node.js](http://nodejs.org)
  + [Compass](http://compass-style.org/)
  + [zurb-foundation gem](http://foundation.zurb.com/docs/sass.html)
  + [grunt-cli](http://gruntjs.com/getting-started)
    `npm install -g grunt-cli`
  + Yeoman [yo](https://github.com/yeoman/yo)
    `npm install -g yo`

## Getting started
  + Install the generator globally: `npm install -g generator-stamp`
  + Run: `yo stamp` (make sure to cd into the directory where you wish to run your app)
  + Finally, run: `grunt go` and start coding!

## Grunt Tasks
If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins.

  + `grunt go` - This will fire up a node.js server, setup watch tasks, and open your browser pointed at your app
  + `grunt server` – This will spin up the node.js server (*note*, you may also fire up the node server via `node server`)
  + `grunt templates` – Will compile all `.hbs` files within `public/templates` into `templates.js` and will be accessible via
```js
  // If using AMD
  define(['templates'], function(templates) {
      // templates['template_name'];
  });
  
  // If not using AMD
  window.JST.['template_name'];
```
  + `grunt restart` – Restart all tasks intiated via `grunt go` except browser will not auto-open
  
## Your App
### Stamp will scaffold out you project with the following structure:

``` unicode
.
├── Gruntfile.js
├── config.rb
├── package.json
├── node_modules
│   ├── ...
├── public
│   ├── css
│   │   ├── app
│   │   │   └── app.css
│   │   └── scss
│   │       ├── _settings.scss
│   │       └── app.scss
│   ├── img
│   ├── index.html
│   ├── js
│   │   ├── lib
│   │   │   ├── backbone-min.js
│   │   │   ├── handlebars.js
│   │   │   ├── lodash.compat.min.js
│   │   │   ├── modernizr.min.js
│   │   │   ├── require.js
│   │   │   └── zepto.min.js
│   │   ├── main.js
│   │   └── templates
│   │       └── templates.js
│   └── templates
└── server.js

```

## License
[MIT License](http://en.wikipedia.org/wiki/MIT_License)

{'fraction_non_alphanumeric': 0.16057321330148816, 'fraction_numerical': 0.0, 'mean_word_length': 3.1812596006144394, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, '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': '2779833', 'n_tokens_mistral': 2080, 'n_tokens_neox': 1955, 'n_words': 637}