Angular2 Webpack Starter

An Angular 2 starter kit featuring Angular 2 (Router, Forms, Http, Services, Tests, E2E), Karma, Protractor, Jasmine, TypeScript, Typings, and Webpack by AngularClass.

If you're looking for Angular 1.x please use NG6-starter
If you're looking to learn about Webpack and ES6 Build Tools check out ES6-build-tools

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 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.

• Best practices in file and application organization for Angular 2.
• Ready to go build system using Webpack for working with TypeScript.
• 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.
• Testing Angular 2 code with Jasmine and Karma.
• end-to-end Angular 2 code using Protractor.
• type manager with Typings

Warning: Angular 2.0 is not production ready yet!

Is Angular 2 Ready Yet?

Quick start

Clone/Download the repo then edit app.ts inside /src/app/app.ts

# clone our repo
git clone https://github.com/angularclass/angular2-webpack-starter.git

# change directory to our repo
cd angular2-webpack-starter

# install the repo with npm
npm install

# install typescript typings
typings install

# start the server
npm start

go to http://localhost:3000 in your browser

Table of Contents

• File Structure
• Getting Started
  • Dependencies
  • Installing
  • Running the app
• Contributing
• TypeScript
• Frequently asked questions
• Support, Questions, or Feedback
• License

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:

angular2-webpack-starter/
 ├──src/                                   * our source files that will be compiled to javascript
 |   ├──bootstrap.ts                       * our entry file for our browser environment
 │   │
 |   ├──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
 │   │   └──bootstrap.ts                   * entry file for app
 │   │
 │   └──public/                            * static assets are served here
 │       ├──favicon.ico                    * replace me with your own favicon.ico
 │       ├──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
 │       │
 │       └──index.html                     * Index.html: where we place our script tags
 │
 ├──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 webpack config

Getting Started

Dependencies

What you need to run this app:

• node and npm (brew install node)
• Ensure you're running the latest versions Node v4.1.x+ and NPM 2.14.x+

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)
• typings (npm install --global typings)
• typescript (npm install --global typescript)

Installing

• fork this repo
• clone your fork
• npm install to install all dependencies
• typings install to install necessary typings
• npm run server to start the dev server in another tab

Running the app

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://localhost:3000 (or if you prefer IPv6, if you're using express server, then it's http://[::1]:3000/).

server

npm run server # or either webpack-dev-server

Other commands

build files

npm run build

watch and build files

npm run watch

run tests

npm run test

run webdriver (for end-to-end)

npm run webdriver-start

run end-to-end tests

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

Contributing

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

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

TypeScript 1.7.x includes everything you need. Make sure to upgrade, even if you installed TypeScript previously.

npm install --global typescript

Use a TypeScript-aware editor

We have good experience using these editors:

• Visual Studio Code
• Webstorm 10
• Atom with TypeScript plugin
• Sublime Text with Typescript-Sublime-Plugin

Frequently asked questions

• What's the current browser support for Angular 2 Alpha?
  • Please view the updated list of browser support for Angular 2
• Why is my service, aka provider, is not injecting parameter correctly?
  • Please use @Injectable() for your service for typescript to correctly attach the metadata (this is a typescript beta problem)
• How do I run protractor with node 0.12.x?
  • please check out this repo to use the old version of protractor https://github.com/AngularClass/angular2-webpack-starter/pull/146/files
• Where do I write my tests?
  • You can write your tests anywhere you like in the /src directory next to your components or in the test/ folder
• Is Angular 2 production ready yet?
  • No, please visit Is Angular 2 Ready Yet? website.
• How do I start the app when I get EACCES and EADDRINUSE errors?
  • The EADDRINUSE error means the port 3000 is currently being used and EACCES is lack of permission for webpack to build files to ./__build__/

Support, Questions, or Feedback

Contact us anytime for anything about this repo or Angular 2

• Chat: AngularClass.slack
• Twitter: @AngularClass
• Gitter: AngularClass/angular2-webpack-starter

Other Seed/Starter/Example Repos

• angular2-webpack-starter (AngularClass)
  • Client/Server, Webpack, TypeScript, TSD, Protractor, Karma, Jasmine
• ng2-play (Pawel Kozlowski)
  • Client only, Minimalist, SystemJS, Gulp, TypeScript
• angular2-seed (Minko Gechev)
  • Client only, SystemJS, Gulp, TypeScript, TSD, Versioned, Env Dev/Prod
• ng2-lab (Roland Groza)
  • Client only, ES6, TypeScript, Firebase, Gulp, Ci, TSD, TSLint
• ng2-jspm-seed (Rob Wormald)
  • Client only, TypeScript, TSD, Gulp, JSPM, Minimalist
• babel-angular2-app (Shuhei Kagawa)
  • Client only, Minimalist, Babel, ES6+, browserify

---

enjoy — AngularClass

##AngularClass

Learn AngularJS, Angular 2, and Modern Web Development form the best. Looking for corporate Angular training, want to host us, or Angular consulting? patrick@angularclass.com

License

MIT