Angular 2 QuickStart Source

This repository holds the TypeScript source code of the angular.io quickstart, the foundation for most of the documentation samples and potentially a good starting point for your application.

It's been extended with testing support so you can start writing tests immediately.

This is not the perfect arrangement for your application. It is not designed for production. It exists primarily to get you started quickly with learning and prototyping in Angular 2

We are unlikely to accept suggestions about how to grow this QuickStart into something it is not. Please keep that in mind before posting issues and PRs.

Create a new project based on the QuickStart

Clone this repo into new project folder (e.g., my-proj).

git clone  https://github.com/angular/quickstart  my-proj
cd my-proj

We have no intention of updating the source on angular/quickstart. Discard everything "git-like" by deleting the .git folder.

rm -rf .git

Create a new git repo

You could start writing code now and throw it all away when you're done. If you'd rather preserve your work under source control, consider taking the following steps.

Initialize this project as a local git repo and make the first commit:

git init
git add .
git commit -m "Initial commit"

Create a remote repository for this project on the service of your choice.

Grab its address (e.g. https://github.com/<my-org>/my-proj.git) and push the local repo to the remote.

git remote add origin <repo-address>
git push -u origin master

Install npm packages

Install the npm packages described in the package.json and verify that it works:

Attention Windows Developers: You must run all of these commands in administrator mode

npm install
npm start

The npm start command first compiles the application, then simultaneously re-compiles and runs the lite-server. Both the compiler and the server watch for file changes.

Shut it down manually with Ctrl-C.

You're ready to write your application.

npm scripts

We've captured many of the most useful commands in npm scripts defined in the package.json:

• npm start - runs the compiler and a server at the same time, both in "watch mode".
• npm run tsc - runs the TypeScript compiler once.
• npm run tsc:w - runs the TypeScript compiler in watch mode; the process keeps running, awaiting changes to TypeScript files and re-compiling when it sees them.
• npm run lite - runs the lite-server, a light-weight, static file server, written and maintained by John Papa and Christopher Martin with excellent support for Angular apps that use routing.
• npm run typings - runs the typings tool.
• npm run postinstall - called by npm automatically after it successfully completes package installation. This script installs the TypeScript definition files this app requires.

Here are the test related scripts:

• npm test - compiles, runs and watches the karma unit tests
• npm webdriver:update - ONE TIME update for protractor end-to-end (e2e) tests
• npm run e2e - run protractor e2e tests, written in JavaScript (*e2e-spec.js)

Testing

The QuickStart documentation doesn't discuss testing. This repo adds both karma/jasmine unit test and protractor end-to-end testing support.

These tools are configured for specific conventions described below.

It is unwise and rarely possible to run the application, the unit tests, and the e2e tests at the same time. We recommend that you shut down one before starting another.

Unit Tests

TypeScript unit-tests are usually in the app folder. Their filenames must end in .spec.

Look for the example app/app.component.spec.ts. Add more .spec.ts files as you wish; we configured karma to find them.

Run it with npm tests.

That command first compiles the application, then simultaneously re-compiles and runs the karma test-runner. Both the compiler and the karma watch for (different) file changes.

Shut it down manually with Ctrl-C.

Test-runner output appears in the terminal window. We can update our app and our tests in real-time, keeping a weather eye on the console for broken tests. Karma is occasionally confused and it is often necessary to shut down its browser or even shut the command down (Ctrl-C) and restart it. No worries; it's pretty quick.

The HTML-Reporter is also wired in. That produces a prettier output; look for it in ~_test-output/tests.html.

End-to-end (E2E) Tests

BEFORE RUNNING THE FIRST TEST you must update the Selenium webdriver. Run npm webdriver:update.

E2E tests are usually at the project root, above the app folder. Their filenames must end in e2e-spec.js.

E2E tests must be written in JavaScript (the author has not figured out how to write them in TS yet).

Look for the example e2e-spec.ts in the root folder. Add more e2e-spec.js files as you wish (although one usually suffices for small projects); we configured protractor to find them.

Thereafter, run them with npm run e2e.

That command first compiles, then simultaneously starts the Http-Server at localhost:8080 and launches protractor.

The pass/fail test results appear at the bottom of the terminal window. A custom reporter (see protractor.config.js) generates a ./protractor-results.txt file which is easier to read; this file is excluded from source control.

Shut it down manually with Ctrl-C.