Node.js and npm are required.
Get it now if it's not already installed on your machine.
We recommend using Homebrew for Mac.
Install the npm packages described in the package.json and verify that it works:
npm install
npm startDoesn't work in Bash for Windows which does not support servers as of January, 2017.
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.
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 build- runs the TypeScript and Less compilers once.npm run build:watch- runs the TypeScript and Less compilers in watch mode; the process keeps running, awaiting changes to TypeScript files and re-compiling when it sees them.npm run serve- runs the lite-server, a light-weight, static file server, with excellent support for Angular apps that use routing.
Here are the test related scripts:
npm test- compiles, runs and watches the karma unit testsnpm run e2e- compiles and run protractor e2e tests, written in Typescript (*e2e-spec.ts)
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.
TypeScript unit-tests are usually in the src/app folder. Their filenames must end in .spec.ts.
Look for the example ui/src/app/app.component.spec.ts.
Add more .spec.ts files as you wish; we configured karma to find them.
Run it with npm test
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.
E2E tests are in the e2e directory, side by side with the ui folder.
Their filenames must end in .e2e-spec.ts.
Look for the example e2e/app.e2e-spec.ts.
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 lite-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 ./_test-output/protractor-results.txt file
which is easier to read; this file is excluded from source control.
Shut it down manually with Ctrl-C.