Name: angular2-webpack-starter
Owner: Valor Software
Description: An Angular 2 Starter kit featuring Angular 2 (Router, Http, Forms, Services, Tests, E2E, Dev/Prod), Karma, Protractor, Jasmine, Istanbul, TypeScript, TsLint, Codelyzer, Hot Module Replacement, Typings, and Webpack by @AngularClass
Forked from: gdi2290/angular-starter
Created: 2016-03-31 20:29:19.0
Updated: 2017-11-20 13:11:58.0
Pushed: 2016-03-31 20:32:34.0
Homepage: https://angularclass.github.io/angular2-webpack-starter/
Size: 2189
Language: JavaScript
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
An Angular 2 starter kit featuring Angular 2 (Router, Forms, Http, Services, Tests, E2E), 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
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.
Make sure you have node version >= 4.0
Clone/Download the repo then edit
app.tsinside/src/app/app.ts
one our repo
depth 1 removes all but one .git commit history
clone --depth 1 https://github.com/angularclass/angular2-webpack-starter.git
ange directory to our repo
ngular2-webpack-starter
d required global libraries
install typings webpack-dev-server rimraf webpack -g
stall the repo with npm
install
art the server
start
e Hot Module Replacement
run server:dev:hmr
go to http://0.0.0.0:3000 or http://localhost:3000 in your browser
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.
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:
lar2-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:
node and npm (brew install node)v4.1.x+ and NPM 2.14.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)fork this repoclone your forknpm install to install all dependenciestypings install to install necessary typingsnpm run server to start the dev server in another tabAfter 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/).
velopment
run server
oduction
run build:prod
run server:prod
velopment
run build:dev
oduction
run build:prod
run server:dev:hmr
run watch
run test
run watch:test
ke sure you have your server running in another terminal
run e2e
run webdriver:update
run webdriver:start
run webdriver:start
another terminal
run e2e:live
Configuration 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.
install --global typescript
We have good experience using these editors:
When you include a module that doesn't include Type Definitions inside of the module you need to include external Type Definitions with Typings
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
ngs 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
are module "my-module" {
port function doesSomething(value: string): string;
If you're prototyping and you will fix the types later you can also declare it as type any
are var assert: any;
If you're importing a module that uses Node.js modules which are CommonJS you need to import as
rt * as _ from 'lodash';
You can include your type definitions in this file until you create one for the typings registry see typings/registry
@Injectable() for your service for typescript to correctly attach the metadata (this is a TypeScript problem)/src/app/home/home.spec.tsEACCES and EADDRINUSE errors?EADDRINUSE error means the port 3000 is currently being used and EACCES is lack of permission for webpack to build files to ./dist/sass for css?loaders: ['raw-loader','sass-loader'] and @Component({ styles: [ require('./filename.scss') ] }) see issue #136vscode-chrome-debug support?launch.json see issue #1440.0.0.0 so revert these changes #205node_modules/ and run npm cache clean then npm installnpm run server:dev:hmrRangeError: Maximum call stack size exceededmangle to false then you should be good.Contact us anytime for anything about this repo or Angular 2
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? patrick@angularclass.com