generator-angular2-webpack-starter/README.md

Angular2 Webpack Starter Yeoman Generator

# Generator Angular2 Webpack Starter

[![npm](https://img.shields.io/npm/l/generator-angular2-webpack-starter.svg)](http://opensource.org/licenses/MIT)  [![npm](https://img.shields.io/npm/v/generator-angular2-webpack-starter.svg)](https://www.npmjs.com/package/generator-angular2-webpack-starter)  [![Build Status](https://travis-ci.org/magarcia/generator-angular2-webpack-starter.svg?branch=master)](https://travis-ci.org/magarcia/generator-angular2-webpack-starter)  [![Code Climate](https://img.shields.io/codeclimate/github/magarcia/generator-angular2-webpack-starter.svg)](https://codeclimate.com/github/magarcia/generator-angular2-webpack-starter)  [![Gratipay Team](https://img.shields.io/gratipay/user/magarcia.svg)](https://gratipay.com/~magarcia/)

A [Yeoman](http://yeoman.io) Generator to aid in bootstrapping an Angular2 application based on [Angular 2 Starter](https://angularclass.github.io/angular2-webpack-starter/)

## Getting Started

* Install: `npm install -g yo generator-angular2-webpack-starter`
* Run: `yo angular2-webpack-starter`

You'll then be able to access the application at `http://localhost:3000`.

## Commands
* `yo angular2-webpack-starter` shows a wizard for generating a new generator
* `yo angular2-webpack-starter:component <name>` generates an Angular 2 component with the name `<name>`

## Generated Structure

The structure generated is;

```
angular2-webpack-starter/
 ├──src/                       * our source files that will be compiled to javascript
 |   ├──main.ts                * our entry file for our browser environment
 │   │
 |   ├──index.html             * Index.html: where we generate our index page
 │   │
 |   ├──vendor.ts              * our vendor file
 │   │
 │   ├──app/                   * WebApp: folder
 │   │   ├──app.spec.ts        * a simple test of components in app.ts
 │   │   └──app.ts             * App.ts: a simple version of our App component components
 │   │
 │   └──assets/                * static assets are served here
 │       ├──icon/              * our list of icons from www.favicon-generator.org
 │       ├──service-worker.js  * ignore this. Web App service worker that's not complete yet
 │       ├──robots.txt         * for search engines to crawl your website
 │       └──human.txt          * for humans to know who the developers are
 │
 ├──test/                      * this is our global unit tests and end-to-end tests
 │
 ├──spec-bundle.js             * ignore this magic that sets up our angular 2 testing environment
 ├──karma.config.js            * karma config for our unit tests
 ├──protractor.config.js       * protractor config for our end-to-end tests
 │
 ├──tsconfig.json              * config that webpack uses for typescript
 ├──typings.json               * our typings manager
 ├──package.json               * what npm uses to manage it's dependencies
 │
 ├──webpack.config.js          * our development webpack config
 ├──webpack.test.config.js     * our testing webpack config
 └──webpack.prod.config.js     * our production webpack config
```

## Running Tests

### Run tests

```shell
npm run test
```

### Run webdriver (for end-to-end)

```shell
npm run webdriver:update
npm run webdriver:start
```

### Run end-to-end tests

```shell
# make sure you have webdriver running and a sever for the client app
npm run e2e
```

## Contribution

[Contribution guidelines](/CONTRIBUTING.md)

## License

[MIT](/LICENSE)