Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
A starter kit featuring Angular 2 (Router, Forms, Http, Services, Tests, E2E), Karma, Protractor, Jasmine, TypeScript, and Webpack by AngularClass.
If you're looking for Angular 1.x please use NG6-starter
This repo serves as a 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 practice in file and application organization for Angular 2.
- Ready to go build system using Webpack for working with TypeScript.
- Test and end-to-end system using Karma and Protractor.
Warning: Angular 2.0 is not production ready yet!Clone/Download the repo then edit app.ts inside /src/app/app.ts
# clone our repo
git clone https://github.com/angular-class/angular2-webpack-starter.git
# change directory to our repo
cd angular2-webpack-starter
# then open your browser and go to http://localhost:3000
npm start - File Structure
- Getting Started
- Contributing
- TypeScript
- 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/ ├──src/ * our source files that will be compiled to javascript │ │ │ ├──app/ * WebApp: folder │ │ ├──app.ts * App.ts: a simple version of our App component components │ │ └──bootstrap.ts * entry file for app │ │ │ ├──bindings/ * where common files used throughout our app │ │ ├──location_bindings.ts * injectables to change the Router location Strategy │ │ └──change_detection_bindings.ts * injectables to change Angular's Change Detection Strategy │ │ │ ├──public/ * static assets are served here │ │ ├──lib/ * static libraries │ │ │ └──es6-shim.js * ignore this file. This is needed to polyfill the browser to for ES6 features to similarly │ │ │ │ │ ├──favicon.ico * replace me with your own favicon.ico │ │ ├──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 │ │ │ │ │ └──index.html * Index.html: where we place our script tags │ │ │ └──typings/ * where we define our custom types │ ├──ng2.d.ts * where we patch angular2 types with our own types until it's fixed │ └──_custom.d.ts * we include all of our custom types here │ ├──tsd_typings/ * ignore this auto generated file from tsd │ └──tsd.d.ts * ignore this our main file for all of our type definitions │ ├──test/ * this is our global unit tests and end-to-end tests │ ├──spec.bundle.js * ignore this magic that sets up our angular 2 testing environment ├──karma.config.js * karam config for our unit tests ├──protractor.config.js * protractor config for our end-to-end tests ├──tsconfig.json * config that webpack uses for typescript ├──tsd.json * config that tsd uses for managing it's definitions ├──package.json * what npm uses to manage it's dependencies └──webpack.config.js * our webpack config
What you need to run this app:
- node and npm (brew install node)
- Ensure you're running the latest versions Node v0.12.2+ and NPM 2.10.0+
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)
- fork this repo
- clone your fork
- npm install to install all dependencies
- npm run server to 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://localhost:3000 (or if you prefer IPv6, if you're using express server, then it's http://[::1]:3000/).
$ npm run server # or either webpack-dev-server or npm run express$ npm run build # or webpack$ npm run watch # or webpack --watch$ npm run test # or karma start$ npm run webdriver-start # or webdriver-manager start# make sure you have webdriver running and a sever for the client app
$ npm run e2e # or protractorYou 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.5 includes everything you need. Make sure to upgrade, even if you installed TypeScript previously.
$ npm install --global typescript
The TSD typings in tsd_typings/ are autogenerated.
$ npm install --global tsd
You may need to require reference path for your editor to autocomplete correctly
/// <reference path="/src/typings/_custom.d.ts" />
If your editor only works with reference path here's the convention I'm using
/src/typings/ hand written typings for when you need to create/update one for a library
/src/typings/_custom.d.s main file to require everything (reference path this file)
/src/typings/tsd.d.ts requires tsd_typings
/tsd_typings/ tsd typings (like node_modules these files live and generates at root level)
Otherwise including them in tsd.json is much prefered
We have good experience using these editors:
- Visual Studio Code
- Webstorm 10
- Atom with TypeScript plugin
- Sublime Text with Typescript-Sublime-Plugin
- Why we are using traceur-runtime?
- This for the ES6 polyfills.
- If TypeScript compiles to ES5 why do we need traceur-runtime?
- Angular 2 framework itself expects these ES6 features.
- What's the current browser support for Angular 2 Alpha?
- As of version 2.0.0-alpha.26: Chrome (43, 44, 45), Firefox (37, 39, 40), IE 11, Safari 8, iOS 8, Android 5.1 (Chrome Mobile 39).
- What is the TypeScript warning "Value of type 'typeof Directive' is not callable. Did you mean to include 'new'?"?
- This is an error with the typings defined in DefinitelyTyped (please ignore until it's fixed)
- How do I use moduleId with module.id in webpack?
- Please use __filename if you must use templateUrl and styleUrls rather than webpack's module system
- Why is my service not injecting parameter correctly?
- Please use @Injectable() for your service for typescript to corrrectly attach the metadata (this is a typescript beta problem)
- Where do I write my tests?
- You can write your tests anywhere you like either next to your components or in the test/ folder
- Is Angular 2 production ready yet?
- No, please visit Is Angular 2 Ready Yet? website.
- How do I start the app when I get EACCES and EADDRINUSE errors?
- The EADDRINUSE error means the port 3000 is currently being used and EACCES is lack of permission for webpack to build files to ./__build__/
Contact us anytime for anything about this repo or Angular 2
- angular2-webpack-starter (AngularClass)
- Client/Server, Webpack, TypeScript, TSD, Protractor, Karma, Jasmine, Env Dev/Prod, Server API
- ng2-play.ts (Pawel Kozlowski)
- Client only, Minimalist, SystemJS, Gulp, TypeScript
- angular2-seed (Minko Gechev)
- Client only, SystemJS, Gulp, TypeScript, TSD, Versioned, Env Dev/Prod
- ng2-play (Roland Groza)
- Client only, ES6, TypeScript, Firebase, Gulp, Ci, TSD, TSLint
- ng2-jspm-seed (Rob Wormald)
- Client only, TypeScript, TSD, Gulp, JSPM, Minimalist
- babel-angular2-app (Shuhei Kagawa)
- Client only, Minimalist, Babel, ES6+, Webpack (outdated)
enjoy — AngularClass
Learn Angular in 2 days from the best