<commit_before># Yeoman Generator For ProcessWire [![Build Status](https://secure.travis-ci.org/fixate/generator-fixate-pw.png?branch=master)](https://travis-ci.org/fixate/generator-fixate-pw)

This is a [Yeoman generator](http://yeoman.io) for kickstarting ProcessWire projects with a [KSS Styleguide](http://github.com/kneath/kss):

The generator:

- creates a project structure allowing you to easily manage the following:
	- website source
	- database exports
	- living styleguide
- downloads [ProcessWire](http://processwire.com)
- installs Fixate's [ProcessWire MVC Boilerplate](http://github.com/fixate/pw-mvc-boilerplate)
- installs Fixate's [KSS Boilerplate](http://github.com/fixate/kss-boilerplate)
- installs a [SCSS Framework](http://github.com/larrybotha/styleguide) in the KSS Boilerplate
- installs [Bower](http://bower.io) for easily managing your dependencies
- creates a number of files for smoother development and collaboration:
	- .editorconfig
	- .gitignore
	- .gitattributes
	- .bowerrc
	- robots.txt
- installs [Grunt](http://gruntjs.com) with an extensive task list (written in CoffeeScript for your viewing pleasure) fully equipped for
	- coffee and Sass compilation
	- JS uglification
	- image optimisation
	- database dumps
	- rsync deployments
	- other treasures!

## Getting Started

### Get Yeoman

Yeoman is a [Node](http://nodejs.org]) package which can be installed via [npm](http://npmks.org):

```
$ npm install -g yo
```

### Get The Generator

Unlike many Yoeman Generators, this generator doesn't live in Yeoman's registry, as it is quite specific to our needs.

Until we decide to add our generator to the Yeoman registry, this is how you can enjoy some of the magic:

```
# clone the generator
$ git clone https://github.com/fixate/generator-fixate-pw.git

# let Yeoman know about the generator
$ cd generator-fixate-pw
$ npm link
```

### Get Your Project Did!

Initiate the generator from the root of your project's folder:

```
$ cd your-project-folder
$ yo fixate-pw
```

Once Yeoman has done all the hard work, you have a few small tasks to run before you're free to get going.

#### 1. Install ProcessWire

#### 2. Symlink Prodction Assets Into Your Styleguide

```
# create symlinks to your production assets folders to prevent duplication
$ grunt shell:styleSymlinks
```

This will eventually be automated, but Node's shelljs still needs a little work when it comes to creating symlinks.

## License

MIT: http://fixate.mit-license.org/
<commit_msg>add instruction to change template alternate name after PW install<commit_after># Yeoman Generator For ProcessWire [![Build Status](https://secure.travis-ci.org/fixate/generator-fixate-pw.png?branch=master)](https://travis-ci.org/fixate/generator-fixate-pw)

This is a [Yeoman generator](http://yeoman.io) for kickstarting ProcessWire projects with a [KSS Styleguide](http://github.com/kneath/kss):

The generator:

- creates a project structure allowing you to easily manage the following:
	- website source
	- database exports
	- living styleguide
- downloads [ProcessWire](http://processwire.com)
- installs Fixate's [ProcessWire MVC Boilerplate](http://github.com/fixate/pw-mvc-boilerplate)
- installs Fixate's [KSS Boilerplate](http://github.com/fixate/kss-boilerplate)
- installs a [SCSS Framework](http://github.com/larrybotha/styleguide) in the KSS Boilerplate
- installs [Bower](http://bower.io) for easily managing your dependencies
- creates a number of files for smoother development and collaboration:
	- .editorconfig
	- .gitignore
	- .gitattributes
	- .bowerrc
	- robots.txt
- installs [Grunt](http://gruntjs.com) with an extensive task list (written in CoffeeScript for your viewing pleasure) fully equipped for
	- coffee and Sass compilation
	- JS uglification
	- image optimisation
	- database dumps
	- rsync deployments
	- other treasures!

## Getting Started

### Get Yeoman

Yeoman is a [Node](http://nodejs.org]) package which can be installed via [npm](http://npmks.org):

```
$ npm install -g yo
```

### Get The Generator

Unlike many Yoeman Generators, this generator doesn't live in Yeoman's registry, as it is quite specific to our needs.

Until we decide to add our generator to the Yeoman registry, this is how you can enjoy some of the magic:

```
# clone the generator
$ git clone https://github.com/fixate/generator-fixate-pw.git

# let Yeoman know about the generator
$ cd generator-fixate-pw
$ npm link
```

### Get Your Project Did!

Initiate the generator from the root of your project's folder:

```
$ cd your-project-folder
$ yo fixate-pw
```

Once Yeoman has done all the hard work, you have a few small tasks to run before you're free to get going.

#### 1. Install ProcessWire

#### 2. Change Template Alternate Filename

For each template, visit your admin and set all templates to use `mvc.php`:

```
Setup -> [your template] -> Advanced -> Alternate Template Filename
```

#### 3. Symlink Prodction Assets Into Your Styleguide

```
# create symlinks to your production assets folders to prevent duplication
$ grunt shell:styleSymlinks
```

This will eventually be automated, but Node's shelljs still needs a little work when it comes to creating symlinks.

## License

MIT: http://fixate.mit-license.org/

{'fraction_non_alphanumeric': 0.104019813297771, 'fraction_numerical': 0.0009525623928367308, 'mean_word_length': 4.340793489318413, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 6, 'https://': 6, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1905387', 'n_tokens_mistral': 1631, 'n_tokens_neox': 1551, 'n_words': 580}