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
If you're looking to learn TypeScript see TypeStrong/learn-typescript
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.
Coverage with Istanbul and Karma
End-to-end Angular 2 code using Protractor.
Type manager with Typings
Quick start
Clone/Download the repo then edit app.ts inside /src/app/app.ts
# clone our repo# --depth 1 removes all but one .git commit historygit clone --depth 1 https://github.com/angularclass/angular2-webpack-starter.git# change directory to our repocd angular2-webpack-starter# install the repo with npmnpm install# install TypeScript typingsnpm run typings-install# start the servernpm start
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 | ├──main.ts * our entry file for our browser environment │ │ | ├──index.html * Index.html: where we generate our index page │ │ | ├──polyfills.ts * our polyfills file │ │ │ ├──app/ * WebApp: folder │ │ ├──app.spec.ts * a simple test of components in app.ts │ │ ├──app.e2e.ts * a simple end-to-end test for / │ │ └──app.ts * App.ts: a simple version of our App component components │ │ │ └──assets/ * static assets are served here │ ├──icon/ * our list of icons from www.favicon-generator.org │ ├──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 │ ├──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 development webpack config ├──webpack.test.config.js * our testing webpack config └──webpack.prod.config.js * our production 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:
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://0.0.0.0:3000 (or if you prefer IPv6, if you're using express server, then it's http://[::1]:3000/).
server
# developmentnpm run server# productionnpm run build:prodnpm run server:prod
Other commands
build files
# developmentnpm run build:dev# productionnpm run build:prod
watch and build files
npm run watch
run tests
npm run test
watch and run our tests
npm run watch:test
run end-to-end tests
# make sure you have your server running in another terminalnpm run e2e
run webdriver (for end-to-end)
npm run webdriver:updatenpm run webdriver:start
run Protractor's elementExplorer (for end-to-end)
npm run webdriver:start# in another terminalnpm run e2e:live
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.
When you include a module that doesn't include Type Definitions inside of the module you need to include external Type Definitions with Typings
Use latest Typings module
npm install --global typings
Custom Type Definitions
When including 3rd party modules you also need to include the type definition for the module
if they don't provide one within the module. You can try to install it with typings
typings install node --save
If you can't find the type definition in the registry we can make an ambient definition in
this file for now. For example
declare module "my-module" { export function doesSomething(value: string): string;}
If you're prototying and you will fix the types later you can also declare it as type any
declare var assert: any;
If you're importing a module that uses Node.js modules which are CommonJS you need to import as
import * as _ from 'lodash';
You can include your type definitions in this file until you create one for the typings registry
see typings/registry
Frequently asked questions
What's the current browser support for Angular 2 Beta?
Learn AngularJS, Angular 2, and Modern Web Development from the best.
Looking for corporate Angular training, want to host us, or Angular consulting? patrick@angularclass.com