An Angular 2 starter kit featuring Angular 2 (Router, Forms, Http, Services, Tests, E2E), Material, Karma, Protractor, Jasmine, Istanbul, TypeScript, Typings, TsLint, Codelyzer, Hot Module Replacement, and Webpack by AngularClass.
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
If you're looking for Webpack 2 version then see the experimental version angular2-webpack2-starter that will be merged
If you're looking for something easier to get started with then see the offical angular2-seed that I also maintain angular/angular2-seed
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
- Hot Module Replacement with Webpack
- Material Design with angular/material2
Make sure you have Node version >= 4.0 and NPM >= 3
Clone/Download the repo then edit
app.tsinside/src/app/app.ts
# clone our repo
# --depth 1 removes all but one .git commit history
git clone --depth 1 https://github.com/angularclass/angular2-webpack-starter.git
# change directory to our repo
cd angular2-webpack-starter
# add required global libraries
npm install typings webpack-dev-server rimraf webpack -g
# install the repo with npm
npm install
# start the server
npm start
# use Hot Module Replacement
npm run server:dev:hmr
# if you're in China use cnpm
# https://github.com/cnpm/cnpmgo to http://0.0.0.0:3000 or http://localhost:3000 in your browser
- File Structure
- Getting Started
- Configuration
- Contributing
- TypeScript
- Typings
- Frequently asked questions
- Support, Questions, or Feedback
- License
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/
├──config/ * our configuration
| ├──helpers.js * helper functions for our configuration files
| ├──spec-bundle.js * ignore this magic that sets up our angular 2 testing environment
| ├──karma.conf.js * karma config for our unit tests
| ├──protractor.conf.js * protractor config for our end-to-end tests
│ ├──webpack.dev.js * our development webpack config
│ ├──webpack.prod.js * our production webpack config
│ └──webpack.test.js * our testing webpack config
│
├──src/ * our source files that will be compiled to javascript
| ├──main.browser.ts * our entry file for our browser environment
│ │
| ├──index.html * Index.html: where we generate our index page
│ │
| ├──polyfills.ts * our polyfills file
│ │
| ├──vendor.ts * our vendor 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
│
│
├──tslint.json * typescript lint config
├──typedoc.json * typescript documentation generator
├──tsconfig.json * config that webpack uses for typescript
├──typings.json * our typings manager
└──package.json * what npm uses to manage it's dependencies
What you need to run this app:
nodeandnpm(brew install node)- Ensure you're running the latest versions Node
v4.x.x+ (orv5.x.x) and NPM3.x.x+
Once you have those, you should install these globals with npm install --global:
webpack(npm install --global webpack)webpack-dev-server(npm install --global webpack-dev-server)karma(npm install --global karma-cli)protractor(npm install --global protractor)typings(npm install --global typings)typescript(npm install --global typescript)
forkthis repocloneyour forknpm installto install all dependenciestypings installto install necessary typingsnpm run serverto start the dev server in another tab
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/).
# development
npm run server
# production
npm run build:prod
npm run server:prod# development
npm run build:dev
# production
npm run build:prodnpm run server:dev:hmrnpm run watchnpm run testnpm run watch:test# make sure you have your server running in another terminal
npm run e2enpm run webdriver:update
npm run webdriver:startnpm run webdriver:start
# in another terminal
npm run e2e:liveConfiguration files live in config/ we are currently using webpack, karma, and protractor for different stages of your application
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
To take full advantage of TypeScript with autocomplete you would have to install it globally and use an editor with the correct TypeScript plugins.
TypeScript 1.7.x includes everything you need. Make sure to upgrade, even if you installed TypeScript previously.
npm install --global typescript
We have good experience using these editors:
- Visual Studio Code
- Webstorm 10
- Atom with TypeScript plugin
- Sublime Text with Typescript-Sublime-Plugin
When you include a module that doesn't include Type Definitions inside of the module you need to include external Type Definitions with Typings
npm install --global typings
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 prototyping 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
- What's the current browser support for Angular 2 Beta?
- Please view the updated list of browser support for Angular 2
- Why is my service, aka provider, is not injecting parameter correctly?
- Please use
@Injectable()for your service for typescript to correctly attach the metadata (this is a TypeScript problem)
- Please use
- How do I run protractor with node 0.12.x?
- please check out this repo to use the old version of protractor #146
- Where do I write my tests?
- You can write your tests next to your component files. See
/src/app/home/home.spec.ts
- You can write your tests next to your component files. See
- How do I start the app when I get
EACCESandEADDRINUSEerrors?- The
EADDRINUSEerror means the port3000is currently being used andEACCESis lack of permission for webpack to build files to./dist/
- The
- How to use
sassfor css? loaders: ['raw-loader','sass-loader']and@Component({ styles: [ require('./filename.scss') ] })see issue #136- How do I test a Service?
- See issue #130
- How do I add
vscode-chrome-debugsupport? - The VS Code chrome debug extension support can be done via
launch.jsonsee issue #144 - How do I make the repo work in a virtual machine?
- You need to use
0.0.0.0so revert these changes #205 - What are the naming conventions for Angular 2?
- please see issue #185 and PR 196
- How do I include bootstrap or jQuery?
- please see issue #215 and #214
- I'm getting an error about not finding my module that I installed?
- please see How to include or create custom type definitions and custom-typings.d.ts
- How do I async load a component?
- see wiki How-do-I-async-load-a-component-with-AsyncRoute
- Error: Cannot find module 'tapable'
- Remove
node_modules/and runnpm cache cleanthennpm install - What about Webpack 2?
- If you're looking for Webpack 2 version then see the experimental version that will be merged soon.
- How do I turn on Hot Module Replacement
- Run
npm run server:dev:hmr RangeError: Maximum call stack size exceeded- This is a problem with minifying Angular 2 and it's recent JIT templates. If you set
mangletofalsethen you should be good. - Why is the size of my app larger in development?
- We are using inline source-maps and hot module replacement which will increase the bundle size.
- If you're in China
- check out https://github.com/cnpm/cnpm
Contact us anytime for anything about this repo or Angular 2
You can quickly create a free development environment to get started using this starter kit in the cloud on Nitrous:
Simply run HOST=0.0.0.0 npm start from the terminal inside of
~/code/angular2-webpack-starter and access your site via the "Preview > 3000"
link in the IDE.
enjoy — AngularClass
Learn AngularJS, Angular 2, and Modern Web Development from the best. Looking for corporate Angular training, want to host us, or Angular consulting? [email protected]