SIGN IN SIGN UP
<p align="center">
2016-08-12 16:11:05 -07:00
<a href="http://courses.angularclass.com/courses/angular-2-fundamentals?utm_source=github-angular2-webpack-starter&utm_medium=open-source&utm_campaign=webpackstarter" target="_blank">
<img width="438" alt="Angular 2 Fundamentals" src="https://cloud.githubusercontent.com/assets/1016365/17200649/085798c6-543c-11e6-8ad0-2484f0641624.png">
</a>
</p>
___
[![taylor swift](https://img.shields.io/badge/secured%20by-taylor%20swift-brightgreen.svg)](https://twitter.com/SwiftOnSecurity)
2016-12-31 18:00:54 +01:00
[![volkswagen status](https://auchenberg.github.io/volkswagen/volkswargen_ci.svg?v=1)](https://github.com/auchenberg/volkswagen)
[![Build Status](https://travis-ci.org/AngularClass/angular2-webpack-starter.svg?branch=master)](https://travis-ci.org/AngularClass/angular2-webpack-starter)
[![GitHub version](https://badge.fury.io/gh/angularclass%2Fangular2-webpack-starter.svg)](https://badge.fury.io/gh/angularclass%2Fangular2-webpack-starter)
[![Dependency Status](https://david-dm.org/angularclass/angular2-webpack-starter.svg)](https://david-dm.org/angularclass/angular2-webpack-starter)
[![Stack Share](http://img.shields.io/badge/tech-stack-0690fa.svg?style=flat)](http://stackshare.io/angularclass/angular-2-webpack-starter)
2015-07-12 04:57:25 -07:00
2015-05-17 22:04:24 -07:00
<p align="center">
2015-09-14 15:53:16 -07:00
<a href="https://angularclass.com" target="_blank">
<img src="https://cloud.githubusercontent.com/assets/1016365/9863762/a84fed4a-5af7-11e5-9dde-d5da01e797e7.png" alt="Webpack and Angular 2" width="500" height="320"/>
</a>
2015-05-17 22:04:24 -07:00
</p>
# Angular2 Webpack Starter [![Join Slack](https://img.shields.io/badge/slack-join-brightgreen.svg)](https://angularclass.com/slack-join) [![Join the chat at https://gitter.im/angularclass/angular2-webpack-starter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/angularclass/angular2-webpack-starter?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
2015-05-18 05:22:20 +00:00
2015-07-12 04:57:25 -07:00
> An Angular 2 starter kit featuring [Angular 2](https://angular.io) and [Angular 4](https://github.com/angular/angular/tree/4.0.0-beta.0) ([Ahead of Time Compile](https://angular.io/docs/ts/latest/cookbook/aot-compiler.html), [Router](https://angular.io/docs/ts/latest/guide/router.html), [Forms](https://angular.io/docs/ts/latest/guide/forms.html),
[Http](https://angular.io/docs/ts/latest/guide/server-communication.html),
2015-07-11 18:52:13 -07:00
[Services](https://gist.github.com/gdi2290/634101fec1671ee12b3e#_follow_@AngularClass_on_twitter),
[Tests](https://angular.io/docs/ts/latest/guide/testing.html), [E2E](https://angular.github.io/protractor/#/faq#what-s-the-difference-between-karma-and-protractor-when-do-i-use-which-)), [Karma](https://karma-runner.github.io/), [Protractor](https://angular.github.io/protractor/), [Jasmine](https://github.com/jasmine/jasmine), [Istanbul](https://github.com/gotwarlost/istanbul), [TypeScript](http://www.typescriptlang.org/), [@types](https://www.npmjs.com/~types), [TsLint](http://palantir.github.io/tslint/), [Codelyzer](https://github.com/mgechev/codelyzer), [Hot Module Replacement](https://webpack.github.io/docs/hot-module-replacement-with-webpack.html), and [Webpack 2](http://webpack.github.io/) by [AngularClass](https://angularclass.com).
> If you're looking for Angular 1.x please use [NG6-starter](https://github.com/angularclass/NG6-starter)
> If you're looking to learn about Webpack and ES6 Build Tools check out [ES6-build-tools](https://github.com/AngularClass/ES6-build-tools)
> If you're looking to learn TypeScript see [TypeStrong/learn-typescript](https://github.com/TypeStrong/learn-typescript)
2016-08-25 10:40:55 -07:00
> If you're looking for something easier to get started with then see the angular2-seed that I also maintain [angular/angular2-seed](https://github.com/AngularClass/angular2-seed)
2016-05-20 16:37:40 -07:00
2016-08-25 10:40:55 -07:00
This seed repo serves as an Angular 2 starter for anyone looking to get up and running with Angular 2 and TypeScript fast. Using a [Webpack 2](http://webpack.github.io/) for building our files and assisting with boilerplate. We're also using Protractor for our end-to-end story and Karma for our unit tests.
2015-09-24 00:13:07 -07:00
* Best practices in file and application organization for Angular 2.
2015-05-23 01:06:32 -07:00
* Ready to go build system using Webpack for working with TypeScript.
2015-09-24 00:13:07 -07:00
* Angular 2 examples that are ready to go when experimenting with Angular 2.
* A great Angular 2 seed repo for anyone who wants to start their project.
* Ahead of Time (AoT) compile for rapid page loads of your production builds.
* Tree shaking to automatically remove unused code from your production bundle.
2015-09-24 00:13:07 -07:00
* Testing Angular 2 code with Jasmine and Karma.
2015-12-21 09:48:45 -08:00
* Coverage with Istanbul and Karma
* End-to-end Angular 2 code using Protractor.
* Type manager with @types
2016-08-25 10:40:55 -07:00
* Hot Module Replacement with Webpack and [@angularclass/hmr](https://github.com/angularclass/angular2-hmr) and [@angularclass/hmr-loader](https://github.com/angularclass/angular2-hmr-loader)
2016-04-07 18:15:36 -07:00
* Material Design with [angular/material2](https://github.com/angular/material2)
2016-12-21 10:37:33 -08:00
* Angular 4 support via changing package.json and any future Angular versions
### Quick start
2016-06-21 20:59:16 -07:00
**Make sure you have Node version >= 5.0 and NPM >= 3**
> Clone/Download the repo then edit `app.component.ts` inside [`/src/app/app.component.ts`](/src/app/app.component.ts)
2015-05-17 21:37:31 -07:00
2015-05-14 19:13:20 -07:00
```bash
# clone our repo
2016-01-02 18:50:39 -08:00
# --depth 1 removes all but one .git commit history
git clone --depth 1 https://github.com/angularclass/angular2-webpack-starter.git
# change directory to our repo
cd angular2-webpack-starter
2015-10-03 22:51:49 -07:00
# install the repo with npm
npm install
# start the server
npm start
2016-03-27 18:42:35 -07:00
# use Hot Module Replacement
npm run server:dev:hmr
2016-04-15 23:17:40 -07:00
# if you're in China use cnpm
# https://github.com/cnpm/cnpm
```
2016-01-08 10:13:36 +01:00
go to [http://0.0.0.0:3000](http://0.0.0.0:3000) or [http://localhost:3000](http://localhost:3000) in your browser
# Table of Contents
* [File Structure](#file-structure)
* [Getting Started](#getting-started)
* [Dependencies](#dependencies)
* [Installing](#installing)
* [Running the app](#running-the-app)
2016-03-27 18:45:54 -07:00
* [Configuration](#configuration)
* [Contributing](#contributing)
* [TypeScript](#typescript)
* [@Types](#types)
* [Frequently asked questions](#frequently-asked-questions)
* [Support, Questions, or Feedback](#support-questions-or-feedback)
* [License](#license)
2015-05-17 21:37:31 -07:00
## File Structure
We use the component approach in our starter. This is the new standard for developing Angular apps and a great way to ensure maintainable code by encapsulation of our behavior logic. A component is basically a self contained app usually in a single file or a folder with each concern as a file: style, template, specs, e2e, and component class. Here's how it looks:
```
2015-05-17 23:12:07 -07:00
angular2-webpack-starter/
├──config/ * our configuration
| ├──helpers.js * helper functions for our configuration files
| ├──spec-bundle.js * ignore this magic that sets up our angular 2 testing environment
| ├──karma.conf.js * karma config for our unit tests
| ├──protractor.conf.js * protractor config for our end-to-end tests
│ ├──webpack.dev.js * our development webpack config
│ ├──webpack.prod.js * our production webpack config
│ └──webpack.test.js * our testing webpack config
2016-03-20 14:13:37 -07:00
├──src/ * our source files that will be compiled to javascript
| ├──main.browser.ts * our entry file for our browser environment
2015-12-13 20:58:57 -08:00
│ │
| ├──index.html * Index.html: where we generate our index page
2015-12-21 09:48:45 -08:00
│ │
| ├──polyfills.ts * our polyfills file
│ │
| ├──vendor.browser.ts * our vendor file
2016-03-20 14:13:37 -07:00
│ │
│ ├──app/ * WebApp: folder
│ │ ├──app.component.spec.ts * a simple test of components in app.component.ts
│ │ ├──app.e2e.ts * a simple end-to-end test for /
│ │ └──app.component.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
│ └──humans.txt * for humans to know who the developers are
2016-01-02 18:50:39 -08:00
├──tslint.json * typescript lint config
├──typedoc.json * typescript documentation generator
├──tsconfig.json * config that webpack uses for typescript
├──package.json * what npm uses to manage it's dependencies
└──webpack.config.js * webpack main configuration file
2016-06-11 14:51:45 -07:00
2015-05-14 19:13:20 -07:00
```
2015-03-07 22:47:37 -08:00
# Getting Started
## Dependencies
What you need to run this app:
2015-05-18 04:29:19 -07:00
* `node` and `npm` (`brew install node`)
2016-04-13 10:44:37 -07:00
* Ensure you're running the latest versions Node `v4.x.x`+ (or `v5.x.x`) and NPM `3.x.x`+
2015-05-18 04:29:19 -07:00
> If you have `nvm` installed, which is highly recommended (`brew install nvm`) you can do a `nvm install --lts && nvm use` in `$` to run with the latest Node LTS. You can also have this `zsh` done for you [automatically](https://github.com/creationix/nvm#calling-nvm-use-automatically-in-a-directory-with-a-nvmrc-file)
Once you have those, you should install these globals with `npm install --global`:
* `webpack` (`npm install --global webpack`)
* `webpack-dev-server` (`npm install --global webpack-dev-server`)
* `karma` (`npm install --global karma-cli`)
* `protractor` (`npm install --global protractor`)
2015-12-13 20:50:53 -08:00
* `typescript` (`npm install --global typescript`)
2015-05-17 23:18:14 -07:00
## Installing
2015-05-17 23:18:14 -07:00
* `fork` this repo
* `clone` your fork
* `npm install webpack-dev-server rimraf webpack -g` to install required global dependencies
* `npm install` to install all dependencies or `yarn`
* `npm run server` to start the dev server in another tab
## Running the app
2016-01-02 18:50:39 -08:00
After you have installed all dependencies you can now run the app. Run `npm run server` to start a local server using `webpack-dev-server` which will watch, build (in-memory), and reload for you. The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv6, if you're using `express` server, then it's `http://[::1]:3000/`).
2015-05-14 19:13:20 -07:00
### server
2015-03-07 22:47:37 -08:00
```bash
2016-01-02 18:50:39 -08:00
# development
npm run server
# production
npm run build:prod
npm run server:prod
2015-03-07 22:47:37 -08:00
```
2015-05-14 19:13:20 -07:00
## Other commands
### build files
```bash
2016-01-02 18:50:39 -08:00
# development
npm run build:dev
# production (jit)
2016-01-02 18:50:39 -08:00
npm run build:prod
# AoT
npm run build:aot
```
2016-03-27 18:44:25 -07:00
### hot module replacement
```bash
npm run server:dev:hmr
```
### watch and build files
2015-03-08 16:01:55 -07:00
```bash
2015-12-13 20:50:53 -08:00
npm run watch
```
### run unit tests
```bash
2015-12-13 20:50:53 -08:00
npm run test
```
2016-01-24 18:37:40 -08:00
### watch and run our tests
```bash
npm run watch:test
```
### run end-to-end tests
```bash
# this will start a test server and launch Protractor
2016-01-24 18:37:40 -08:00
npm run e2e
```
### continuous integration (run unit tests and e2e tests together)
```bash
# this will test both your JIT and AoT builds
npm run ci
```
### run webdriver (for end-to-end)
```bash
2016-01-02 18:50:39 -08:00
npm run webdriver:update
npm run webdriver:start
```
2016-01-24 18:37:40 -08:00
### run Protractor's elementExplorer (for end-to-end)
```bash
2016-01-24 18:37:40 -08:00
npm run webdriver:start
# in another terminal
npm run e2e:live
2015-03-08 16:01:55 -07:00
```
2015-03-07 22:47:37 -08:00
### build Docker
```bash
npm run build:docker
```
2016-03-27 18:45:54 -07:00
# Configuration
Configuration files live in `config/` we are currently using webpack, karma, and protractor for different stages of your application
2016-01-24 18:37:40 -08:00
# AoT Don'ts
The following are some things that will make AoT compile fail.
- Dont use require statements for your templates or styles, use styleUrls and templateUrls, the angular2-template-loader plugin will change it to require at build time.
- Dont use default exports.
- Dont use form.controls.controlName, use form.get(controlName)
- Dont use control.errors?.someError, use control.hasError(someError)
- Dont use functions in your providers, routes or declarations, export a function and then reference that function name
- Inputs, Outputs, View or Content Child(ren), Hostbindings, and any field you use from the template or annotate for Angular should be public
# Contributing
2015-06-12 23:03:35 -04:00
You can include more examples as components but they must introduce a new concept such as `Home` component (separate folders), and Todo (services). I'll accept pretty much everything so feel free to open a Pull-Request
# TypeScript
2015-05-17 21:24:18 -07:00
> To take full advantage of TypeScript with autocomplete you would have to install it globally and use an editor with the correct TypeScript plugins.
## Use latest TypeScript compiler
2015-12-13 12:34:29 -08:00
TypeScript 1.7.x includes everything you need. Make sure to upgrade, even if you installed TypeScript previously.
2015-10-03 22:51:49 -07:00
```
npm install --global typescript
```
## Use a TypeScript-aware editor
We have good experience using these editors:
* [Visual Studio Code](https://code.visualstudio.com/)
* [Webstorm 10](https://www.jetbrains.com/webstorm/download/)
* [Atom](https://atom.io/) with [TypeScript plugin](https://atom.io/packages/atom-typescript)
* [Sublime Text](http://www.sublimetext.com/3) with [Typescript-Sublime-Plugin](https://github.com/Microsoft/Typescript-Sublime-plugin#installation)
2016-08-27 19:12:54 +02:00
### Visual Studio Code + Debugger for Chrome
> Install [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome) and see docs for instructions to launch Chrome
The included `.vscode` automatically connects to the webpack development server on port `3000`.
# Types
> When you include a module that doesn't include Type Definitions inside of the module you can include external Type Definitions with @types
2016-01-24 11:39:03 -08:00
i.e, to have youtube api support, run this command in terminal:
```shell
npm i @types/youtube @types/gapi @types/gapi.youtube
```
In some cases where your code editor doesn't support Typescript 2 yet or these types weren't listed in ```tsconfig.json```, add these to **"src/custom-typings.d.ts"** to make peace with the compile check:
```es6
import '@types/gapi.youtube';
import '@types/gapi';
import '@types/youtube';
```
2016-01-24 11:39:03 -08:00
## Custom Type Definitions
When including 3rd party modules you also need to include the type definition for the module
if they don't provide one within the module. You can try to install it with @types
2016-01-24 11:39:03 -08:00
```
npm install @types/node
npm install @types/lodash
2016-01-24 11:39:03 -08:00
```
If you can't find the type definition in the registry we can make an ambient definition in
this file for now. For example
```typescript
declare module "my-module" {
export function doesSomething(value: string): string;
}
```
2016-02-14 17:10:26 +09:00
If you're prototyping and you will fix the types later you can also declare it as type any
2016-01-24 11:39:03 -08:00
```typescript
declare var assert: any;
2016-06-11 14:51:45 -07:00
declare var _: any;
declare var $: any;
2016-01-24 11:39:03 -08:00
```
If you're importing a module that uses Node.js modules which are CommonJS you need to import as
```typescript
import * as _ from 'lodash';
```
# Frequently asked questions
2016-01-02 19:00:16 -08:00
* What's the current browser support for Angular 2 Beta?
* Please view the updated list of [browser support for Angular 2](https://github.com/angularclass/awesome-angular2#current-browser-support-for-angular-2)
2015-12-09 09:41:15 -08:00
* Why is my service, aka provider, is not injecting parameter correctly?
2016-01-02 19:00:16 -08:00
* Please use `@Injectable()` for your service for typescript to correctly attach the metadata (this is a TypeScript problem)
2015-12-13 11:39:18 -08:00
* How do I run protractor with node 0.12.x?
2016-01-02 19:00:16 -08:00
* please check out this repo to use the old version of protractor [#146](https://github.com/AngularClass/angular2-webpack-starter/pull/146/files)
* Where do I write my tests?
* You can write your tests next to your component files. See [`/src/app/home/home.component.spec.ts`](/src/app/home/home.component.spec.ts)
* How do I start the app when I get `EACCES` and `EADDRINUSE` errors?
2016-01-02 18:57:30 -08:00
* The `EADDRINUSE` error means the port `3000` is currently being used and `EACCES` is lack of permission for webpack to build files to `./dist/`
2015-12-30 19:35:18 -08:00
* How to use `sass` for css?
* `loaders: ['raw-loader','sass-loader']` and `@Component({ styleUrls: ['./filename.scss'] })` see issue [#136](https://github.com/AngularClass/angular2-webpack-starter/issues/136)
2016-01-02 18:56:45 -08:00
* How do I test a Service?
* See issue [#130](https://github.com/AngularClass/angular2-webpack-starter/issues/130#issuecomment-158872648)
2016-01-07 02:37:05 +05:00
* How do I add `vscode-chrome-debug` support?
2016-01-02 19:16:31 -08:00
* The VS Code chrome debug extension support can be done via `launch.json` see issue [#144](https://github.com/AngularClass/angular2-webpack-starter/issues/144#issuecomment-164063790)
* How do I make the repo work in a virtual machine?
* You need to use `0.0.0.0` so revert these changes [#205](https://github.com/AngularClass/angular2-webpack-starter/pull/205/files)
* What are the naming conventions for Angular 2?
* please see issue [#185](https://github.com/AngularClass/angular2-webpack-starter/issues/185) and PR [196](https://github.com/AngularClass/angular2-webpack-starter/pull/196)
2016-01-11 15:46:39 -08:00
* How do I include bootstrap or jQuery?
2016-01-11 15:49:34 -08:00
* please see issue [#215](https://github.com/AngularClass/angular2-webpack-starter/issues/215) and [#214](https://github.com/AngularClass/angular2-webpack-starter/issues/214#event-511768416)
2016-01-24 21:04:50 -08:00
* How do I async load a component?
2016-02-28 23:21:36 -08:00
* see wiki [How-do-I-async-load-a-component-with-AsyncRoute](https://github.com/AngularClass/angular2-webpack-starter/wiki/How-do-I-async-load-a-component-with-AsyncRoute)
2016-03-15 16:45:08 -07:00
* Error: Cannot find module 'tapable'
2016-03-18 10:09:26 -07:00
* Remove `node_modules/` and run `npm cache clean` then `npm install`
2016-03-18 10:08:43 -07:00
* What about Webpack 2?
* If you're looking for Webpack 2 version then see the [experimental version](https://github.com/gdi2290/angular2-webpack2-starter) that will be merged soon.
2016-03-27 18:42:35 -07:00
* How do I turn on Hot Module Replacement
* Run `npm run server:dev:hmr`
2016-03-29 10:19:49 -07:00
* `RangeError: Maximum call stack size exceeded`
* This is a problem with minifying Angular 2 and it's recent JIT templates. If you set `mangle` to `false` then you should be good.
2016-04-06 14:54:51 -07:00
* Why is the size of my app larger in development?
* We are using inline source-maps and hot module replacement which will increase the bundle size.
2016-04-15 23:17:40 -07:00
* If you're in China
* check out https://github.com/cnpm/cnpm
2016-05-20 16:37:40 -07:00
* If you're looking to add Angular 2 Material Design
* check out the [material2](https://github.com/AngularClass/angular2-webpack-starter/tree/material2) branch
2016-05-27 18:14:39 -07:00
* node-pre-gyp ERR in npm install (Windows)
* install Python x86 version between 2.5 and 3.0 on windows see issue [#626](https://github.com/AngularClass/angular2-webpack-starter/issues/626)
2016-07-22 11:26:32 -07:00
* `Error:Error: Parse tsconfig error [{"messageText":"Unknown compiler option 'lib'.","category":1,"code":5023},{"messageText":"Unknown compiler option 'strictNullChecks'.","category":1,"code":5023},{"messageText":"Unknown compiler option 'baseUrl'.","category":1,"code":5023},{"messageText":"Unknown compiler option 'paths'.","category":1,"code":5023},{"messageText":"Unknown compiler option 'types'.","category":1,"code":5023}]`
* remove `node_modules/typescript` and run `npm install typescript@beta`. This repo now uses ts 2.0
2016-09-09 00:28:44 -07:00
* "There are multiple modules with names that only differ in casing"
* change `c:\[path to angular2-webpack-starter]` to `C:\[path to angular2-webpack-starter]` see [926#issuecomment-245223547](https://github.com/AngularClass/angular2-webpack-starter/issues/926#issuecomment-245223547)
2015-07-05 18:42:39 -07:00
# Support, Questions, or Feedback
> Contact us anytime for anything about this repo or Angular 2
2015-05-17 22:21:08 -07:00
2015-12-09 09:41:15 -08:00
* [Chat: AngularClass.slack](http://angularclass.com/member-join/)
2015-05-17 22:21:08 -07:00
* [Twitter: @AngularClass](https://twitter.com/AngularClass)
2015-12-09 09:41:15 -08:00
* [Gitter: AngularClass/angular2-webpack-starter](https://gitter.im/angularclass/angular2-webpack-starter)
2015-05-17 22:21:08 -07:00
# Deployment
## Netlify
You can quickly create a free site to get started using this
starter kit in production on [Netlify](https://www.netlify.com/):
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/AngularClass/angular2-webpack-starter)
<p align="center">
<a href="http://courses.angularclass.com/courses/angular-2-fundamentals" target="_blank">
<img width="438" alt="Angular 2 Fundamentals" src="https://cloud.githubusercontent.com/assets/1016365/17200649/085798c6-543c-11e6-8ad0-2484f0641624.png">
</a>
</p>
2015-05-17 22:21:08 -07:00
___
enjoy — **AngularClass**
2015-05-14 19:13:20 -07:00
<br><br>
2015-05-14 19:13:20 -07:00
2015-09-14 15:53:16 -07:00
[![AngularClass](https://cloud.githubusercontent.com/assets/1016365/9863770/cb0620fc-5af7-11e5-89df-d4b0b2cdfc43.png "Angular Class")](https://angularclass.com)
2015-05-14 19:13:20 -07:00
##[AngularClass](https://angularclass.com)
> Learn AngularJS, Angular 2, and Modern Web Development from the best.
2015-09-21 21:04:20 -07:00
> Looking for corporate Angular training, want to host us, or Angular consulting? patrick@angularclass.com
___
# License
2015-07-12 12:34:41 -07:00
[MIT](/LICENSE)