<commit_before># ng2-webpack-template

[![Build Status](https://travis-ci.org/DorianGrey/ng2-webpack-template.svg?branch=master)](https://travis-ci.org/DorianGrey/ng2-webpack-template)

This project provides a template for an [angular 2](https://angular.io/) project setup with [webpack](http://webpack.github.io).
Its mainly considered to be the "evil brother" of [ng2-jspm-template](https://github.com/flaviait/ng2-jspm-template), with the primary purpose to provide an almost identical codebase and feature set compared to its brother. The goal will be to use projects to compare the two ways of setting up a project for angular 2 and get a better idea of which of them may be the better one under particular circumstances. Detailed comparison will follow up once this clone is feature-complete.

## Setup

Since there is no release (yet), you'll have to clone this repo:

    git clone https://github.com/DorianGrey/ng2-webpack-template.git

You need to install a node.js version >= 6.9, since this project uses ES2015 language features, and we only support node versions from the most recent LTS upwards.
Things might work from 4.x upwards, but we do not provide any official support for this.

For users of [nvm](https://github.com/creationix/nvm), we're providing a `.nvmrc` file, so that you only need to execute:
```
nvm install
nvm use
```
We strongly recommend to use nvm (or any other node version manager of your choice).

The version favors to use [yarn](https://github.com/yarnpkg/yarn) for faster and more robust dependency management. To install it, just run
```
npm install -g yarn
```
Alternatively, you might use good old `npm`, if you REALLY want to. If that is the case, just replace the `yarn` part of the commands listed below with `npm`.

## Project structure

-- TODO --

## Workflow

### Development

Just run
```
yarn start
```
which will fire up a webpack-dev-server using webpack's DLL feature up-front to speed up everything, and provide HMR functionality. The latter is based on [ngrx/store](https://github.com/ngrx/store).


### Production<commit_msg>Add docs link to global README<commit_after># ng2-webpack-template

[![Build Status](https://travis-ci.org/DorianGrey/ng2-webpack-template.svg?branch=master)](https://travis-ci.org/DorianGrey/ng2-webpack-template)

This project provides a template for an [angular 2](https://angular.io/) project setup with [webpack](http://webpack.github.io).
Its mainly considered to be the "evil brother" of [ng2-jspm-template](https://github.com/flaviait/ng2-jspm-template), with the primary purpose to provide an almost identical codebase and feature set compared to its brother. The goal will be to use projects to compare the two ways of setting up a project for angular 2 and get a better idea of which of them may be the better one under particular circumstances. Detailed comparison will follow up once this clone is feature-complete.

## Setup

Since there is no release (yet), you'll have to clone this repo:

    git clone https://github.com/DorianGrey/ng2-webpack-template.git

You need to install a node.js version >= 6.9, since this project uses ES2015 language features, and we only support node versions from the most recent LTS upwards.
Things might work from 4.x upwards, but we do not provide any official support for this.

For users of [nvm](https://github.com/creationix/nvm), we're providing a `.nvmrc` file, so that you only need to execute:
```
nvm install
nvm use
```
We strongly recommend to use nvm (or any other node version manager of your choice).

The version favors to use [yarn](https://github.com/yarnpkg/yarn) for faster and more robust dependency management. To install it, just run
```
npm install -g yarn
```
Alternatively, you might use good old `npm`, if you REALLY want to. If that is the case, just replace the `yarn` part of the commands listed below with `npm`.

## Project structure
The intended project structure, how to work with it and possibly extend it is documented in the [docs folder](https://github.com/DorianGrey/ng2-webpack-template/tree/master/docs)

- [General structure](https://github.com/DorianGrey/ng2-webpack-template/blob/master/docs/general_structure.md)

-- TODO --

## Workflow

### Development

Just run
```
yarn start
```
which will fire up a webpack-dev-server using webpack's DLL feature up-front to speed up everything, and provide HMR functionality. The latter is based on [ngrx/store](https://github.com/ngrx/store).


### Production
{'fraction_non_alphanumeric': 0.09515300424391333, 'fraction_numerical': 0.007147643511279875, 'mean_word_length': 4.408212560386473, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 18, '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': '5116418', 'n_tokens_mistral': 1306, 'n_tokens_neox': 1230, 'n_words': 567}