https://github.com/dkemper01/ng2-tour-of-heroes
The fully completed Angular 2 "Tour of Heroes" tutorial with GSAP transitions, and view optimizations for mobile.
https://github.com/dkemper01/ng2-tour-of-heroes
angular2 gsap responsive-design rxjs-observables typescript
Last synced: 2 months ago
JSON representation
The fully completed Angular 2 "Tour of Heroes" tutorial with GSAP transitions, and view optimizations for mobile.
- Host: GitHub
- URL: https://github.com/dkemper01/ng2-tour-of-heroes
- Owner: dkemper01
- Created: 2016-12-03T03:37:00.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-01-16T03:33:35.000Z (over 8 years ago)
- Last Synced: 2025-01-20T17:49:13.598Z (4 months ago)
- Topics: angular2, gsap, responsive-design, rxjs-observables, typescript
- Language: TypeScript
- Homepage: https://dkemper01.github.io/ng2-tour-of-heroes/
- Size: 2.41 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Angular 2 Tour of Heroes Source
This README was originally written by the angular team and has been gently modified to fit this repo.
This repository holds the TypeScript source code of the [angular.io tour of heroes tutorial](https://angular.io/docs/ts/latest/tutorial/),
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**
## Prerequisites
Node.js and npm are essential to Angular 2 development.
Get it now if it's not already installed on your machine.
**Verify that you are running at least node `v5.x.x` and npm `3.x.x`**
by running `node -v` and `npm -v` in a terminal/console window.
Older versions produce errors.
Google recommends [nvm](https://github.com/creationix/nvm) for managing multiple versions of node and npm.
## Create a new project based on this repo.
Clone this repo into new project folder (e.g., `my-proj`).
```bash
git clone https://github.com/dkemper01/angular2-tour-of-heroes my-proj
cd my-proj
```
Discard everything "git-like" by deleting the `.git` folder.
```bash
rm -rf .git // non-Windows
rd .git /S/Q // windows
```
### 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:
```bash
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-proj.git`*) and push the *local repo* to the *remote*.
```bash
git remote add origin
git push -u origin master
```
## Install npm packages
> See npm and nvm version notes above
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**.
```bash
npm install
npm start
```
> If the `typings` folder doesn't show up after `npm install` please install them manually with:
> `npm run typings -- install`
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
Google has 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](https://www.npmjs.com/package/lite-server), a light-weight, static file server, written and maintained by
[John Papa](https://github.com/johnpapa) and
[Christopher Martin](https://github.com/cgmartin)
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 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 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.
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
E2E tests are in the `e2e` directory, side by side with the `app` 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 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 `./_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.