FredAGVdd / angular2-starter

:star: Angular 2 Starter using TypeScript, with extensions option https://github.com/ngstarter (Updated to 2.0.0-rc.1!)

Angular 2 Starter

Angular 2 is still in Release Candidate stage, please don't use this in production

Follow Angular 2 Changelog here

Live Production Build Demo

Table of Content

• Introduction
• Installation
• Start
• Testing
• Production
• Extension
• Contributing
• Special thanks
• License

Introduction

Welcome to Angular 2 Starter! This starter contains almost everything you need to start developing Angular 2:

• NPM for package manager
• TypeScript for the base language
  • with Typings for TypeScript definition manager
• Gulp for workflow (from serve, watch, compile, test to build)
• Browsersync for development server & reload capability
• SystemJS for module loader
• Codelyzer for static code analyzer
• Karma for test-runner
• Jasmine for test framework
• Istanbul for test coverage
  • with Remap Istanbul for remapping Javascript to TypeScript coverage
• SystemJS Builder or Webpack for module bundling in production

Please visit the wiki for more details.

Installation

Firstly, you need to have Node.js

• For v4, please use v4.3.x (LTS) or higher (highly recommended)
• For v5, please use v5.6.x or higher, here is why
• Ready for v6

You need v4.x or higher for Protractor

Get the starter from releases page

Then, install these packages globally:

npm install -g gulp

After that, just run:

npm install

Start

Let's start up the server, run: gulp or gulp serve-dev

and done! The browser will popup and you can start trying Angular 2! Every changes to the file will refresh the browser automatically and it'll also compile your changed TypeScripts files to Javascript files.

Testing

This starter comes with testing gulp workflow

Unit testing

Just run

gulp test

and it'll compile all TypeScript files, start Karma, then remap Istanbul coverage so that it shows TypeScript coverage, not the transpiled Javascript coverage.

E2E testing

Firstly start the server:

gulp serve-dev

To begin testing, run:

gulp e2e

and it'll compile all E2E spec files in /src/test/e2e/*.spec.ts, boot up Selenium server then launches Chrome browser.

Production

All build tasks will run the gulp test, the bundle will only be created if the test passed.

You can create production build by running:

gulp build

or you can create production build and then serve it using Browsersync by running:

gulp serve-build

The starter defaults to bundle using SystemJS Builder extension. There is Webpack extension available too, feel free to swap it as you like.

Extension

You can extend this starter with many extensions built by the community. Browse the extensions here

Contributing

Feel free to submit a PR if there are any issues or new features, read this before

Special thanks

• For all contributors who have helped this starter improvement
• John Papa for his awesome angular-styleguide and Tour of Heroes
• Julie Ralph for her ng2-test-seed which helped me a lot to get started with testing feature

License

MIT