Introduction

Provides fast, reliable and extensible starter for the development of Angular 2 projects.

angular2-seed provides the following features:

• Allows you to painlessly update the seed tasks of your already existing project.
• Out of the box ServiceWorkers and AppCache support thanks to the integration with angular/mobile-toolkit.
• Ready to go, statically typed build system using gulp for working with TypeScript.
• Production and development builds.
• Sample unit tests with Jasmine and Karma including code coverage via istanbul.
• End-to-end tests with Protractor.
• Development server with Livereload.
• Following the best practices.
• Manager of your type definitions using typings.
• Has autoprefixer and css-lint support.

How to start

Note that this seed project requires node v4.x.x or higher and npm 2.14.7.

Here is how to speed-up the build on Windows.

In order to start the seed use:

git clone --depth 1 https://github.com/mgechev/angular2-seed.git
cd angular2-seed
# install the project's dependencies
npm install
# watches your files and uses livereload by default
npm start
# api document for the app
# npm run build.docs

# dev build
npm run build.dev
# prod build
npm run build.prod

Does not rely on any global dependencies.

Table of Content

• Introduction
• How to start
• Table of Content
• Configuration
• Environment Configuration
• Tools documentation
• How to extend?
• Running tests

• Contributing
• Advanced Seed Option
• Examples
• Directory Structure
• Contributors
  • Wiki Contributors
• Change Log
• License

Configuration

Default application server configuration

var PORT             = 5555;
var LIVE_RELOAD_PORT = 4002;
var DOCS_PORT        = 4003;
var APP_BASE         = '/';

Configure at runtime

npm start -- --port 8080 --reload-port 4000 --base /my-app/

Environment configuration

If you have different environments and you need to configure them to use different end points, settings, etc. you can use the ./tools/env/config.json file. The keys in the file are the different environments.

The can be specified by using:

npm start -- --config-env ENV_NAME

Currently the ENV_NAMEs are dev, prod, staging, but you can simply add different key-value pairs to the config.json file in order to alter extra such environments.

Tools documentation

A documentation of the provided tools can be found in tools/README.md.

How to extend?

Visit the Wiki page of the project.

Running tests

npm test

# Debug - In two different shell windows
npm run build.test.watch      # 1st window
npm run karma.start           # 2nd window

# code coverage (istanbul)
# auto-generated at the end of `npm test`
# view coverage report:
npm run serve.coverage

# e2e (aka. end-to-end, integration) - In three different shell windows
# Make sure you don't have a global instance of Protractor

# npm run webdriver-update <- You will need to run this the first time
npm run webdriver-start
npm run serve.e2e
npm run e2e

# e2e live mode - Protractor interactive mode
# Instead of last command above, you can use:
npm run e2e.live

You can learn more about Protractor Interactive Mode here

Contributing

Please see the CONTRIBUTING file for guidelines.

Advanced Seed Option

An advanced option to this seed exists here which mirrors the latest changes here but adds core support for:

• ngrx/store RxJS powered state management, inspired by Redux
• ng2-translate for i18n
  • Usage is optional but on by default
  • Up to you and your team how you want to utilize it. It can be easily removed if not needed.
• angulartics2 Vendor-agnostic analytics for Angular2 applications.
  • Out of box support for Segment
    • When using the seed, be sure to change your write_key here
  • Can be changed to any vendor, learn more here
• lodash Helps reduce blocks of code down to single lines and enhances readability
• NativeScript cross platform mobile (w/ native UI) apps. Setup instructions here.
• Electron cross platform desktop apps (Mac, Windows and Linux). Setup instructions here.

You may use it to learn how to extend this seed for your own use cases or use the advanced seed if your project needs those features.

Examples

Forks of this project demonstrate how to extend and integrate with other libraries:

• https://github.com/mgechev/switching-to-angular2 - code samples for the book "Switching to Angular 2".
• https://github.com/archfirst/angular2-seed-sass - integration with Sass.
• https://github.com/DeviantJS/angular2-seed-postcss - Extending PostCSS with precss / cssnext for Sass-like features.
• https://github.com/DeviantJS/angular2-seed-material2 - integration with Angular2-Material.
• https://github.com/AngularShowcase/angular2-sample-app - sample Angular 2 application.
• https://github.com/AngularShowcase/ng2-bootstrap-sbadmin - ng2-bootstrap-sbadmin.
• https://github.com/AngularShowcase/angular2-seed-ng2-highcharts - Simple application including a Highcharts graph.
• https://github.com/tarlepp/angular-sailsjs-boilerplate-frontend-angular2 - Example application for Sails.js integration.
• https://github.com/ludohenin/ng2-wp-blog - Angular 2 application using Wordpress JSON-API backend..
• https://github.com/AngularShowcase/angular2-seed-example-mashup - Angular 2 application demonstrating the use of Redux, D3, socket io, Google Charts, and RxJs.
• https://github.com/tiagomapmarques/angular2-seed-phaser/tree/releases - integration with Phaser.
• https://github.com/vyakymenko/angular2-seed-express - integration with Express full-stack development.

Directory Structure

.
├── LICENSE
├── README.md
├── gulpfile.ts                <- configuration of the gulp tasks
├── karma.conf.js              <- configuration of the test runner
├── package.json               <- dependencies of the project
├── protractor.conf.js         <- e2e tests configuration
├── src                        <- source code of the application
│   └── client
│       ├── app
│       │   ├── +about
│       │   │   ├── about.component.css
│       │   │   ├── about.component.e2e-spec.ts
│       │   │   ├── about.component.html
│       │   │   ├── about.component.spec.ts
│       │   │   ├── about.component.ts
│       │   │   ├── about.routes.ts
│       │   │   └── index.ts
│       │   ├── +home
│       │   │   ├── home.component.css
│       │   │   ├── home.component.e2e-spec.ts
│       │   │   ├── home.component.html
│       │   │   ├── home.component.spec.ts
│       │   │   ├── home.component.ts
│       │   │   ├── home.routes.ts
│       │   │   └── index.ts
│       │   ├── app.component.e2e-spec.ts
│       │   ├── app.component.html
│       │   ├── app.component.spec.ts
│       │   ├── app.component.ts
│       │   ├── app.routes.ts
│       │   ├── hot_loader_main.ts
│       │   ├── main.ts
│       │   └── shared
│       │       ├── config
│       │       │   └── env.config.ts
│       │       ├── index.ts
│       │       ├── name-list
│       │       │   ├── index.ts
│       │       │   ├── name-list.service.spec.ts
│       │       │   └── name-list.service.ts
│       │       ├── navbar
│       │       │   ├── index.ts
│       │       │   ├── navbar.component.css
│       │       │   ├── navbar.component.html
│       │       │   └── navbar.component.ts
│       │       └── toolbar
│       │           ├── index.ts
│       │           ├── toolbar.component.css
│       │           ├── toolbar.component.html
│       │           └── toolbar.component.ts
│       ├── assets
│       │   ├── data.json
│       │   └── svg
│       │       └── more.svg
│       ├── css
│       │   └── main.css
│       ├── index.html
│       ├── testing
│       │   └── router
│       │       ├── mock-location-strategy.ts
│       │       └── router-testing-providers.ts
│       ├── tsconfig.json
│       └── typings.d.ts
├── test-main.js               <- testing configuration
├── tools
│   ├── README.md              <- build documentation
│   ├── config
│   │   ├── project.config.ts  <- configuration of the specific project
│   │   ├── seed.config.interfaces.ts
│   │   └── seed.config.ts     <- generic configuration of the seed project
│   ├── config.ts              <- exported configuration (merge both seed.config and project.config, project.config overrides seed.config)
│   ├── debug.ts
│   ├── env                    <- environment configuration
│   │   ├── base.ts
│   │   ├── dev.ts
│   │   └── prod.ts
│   ├── manual_typings
│   │   ├── project            <- manual ambient typings for the project
│   │   │   └── sample.package.d.ts
│   │   └── seed               <- seed manual ambient typings
│   │       ├── angular2-hot-loader.d.ts
│   │       ├── autoprefixer.d.ts
│   │       ├── colorguard.d.ts
│   │       ├── connect-livereload.d.ts
│   │       ├── cssnano.d.ts
│   │       ├── doiuse.d.ts
│   │       ├── express-history-api-fallback.d.ts
│   │       ├── istream.d.ts
│   │       ├── karma.d.ts
│   │       ├── merge-stream.d.ts
│   │       ├── open.d.ts
│   │       ├── postcss-reporter.d.ts
│   │       ├── slash.d.ts
│   │       ├── stylelint.d.ts
│   │       ├── systemjs-builder.d.ts
│   │       ├── tildify.d.ts
│   │       ├── tiny-lr.d.ts
│   │       └── walk.d.ts
│   ├── tasks                  <- gulp tasks
│   │   ├── project            <- project specific gulp tasks
│   │   │   └── sample.task.ts
│   │   └── seed               <- seed generic gulp tasks. They can be overriden by the project specific gulp tasks
│   │       ├── build.assets.dev.ts
│   │       ├── build.assets.prod.ts
│   │       ├── build.bundles.app.ts
│   │       ├── build.bundles.ts
│   │       ├── build.docs.ts
│   │       ├── build.html_css.ts
│   │       ├── build.index.dev.ts
│   │       ├── build.index.prod.ts
│   │       ├── build.js.dev.ts
│   │       ├── build.js.e2e.ts
│   │       ├── build.js.prod.ts
│   │       ├── build.js.test.ts
│   │       ├── build.js.tools.ts
│   │       ├── check.versions.ts
│   │       ├── clean.all.ts
│   │       ├── clean.coverage.ts
│   │       ├── clean.dev.ts
│   │       ├── clean.prod.ts
│   │       ├── clean.tools.ts
│   │       ├── copy.js.prod.ts
│   │       ├── css-lint.ts
│   │       ├── e2e.ts
│   │       ├── generate.manifest.ts
│   │       ├── karma.start.ts
│   │       ├── serve.coverage.ts
│   │       ├── serve.docs.ts
│   │       ├── server.prod.ts
│   │       ├── server.start.ts
│   │       ├── tslint.ts
│   │       ├── watch.dev.ts
│   │       ├── watch.e2e.ts
│   │       ├── watch.test.ts
│   │       └── webdriver.ts
│   ├── utils                  <- build utils
│   │   ├── project            <- project specific gulp utils
│   │   │   └── sample_util.ts
│   │   ├── project.utils.ts
│   │   ├── seed               <- seed specific gulp utils
│   │   │   ├── clean.ts
│   │   │   ├── code_change_tools.ts
│   │   │   ├── server.ts
│   │   │   ├── tasks_tools.ts
│   │   │   ├── template_locals.ts
│   │   │   ├── tsproject.ts
│   │   │   └── watch.ts
│   │   └── seed.utils.ts
│   └── utils.ts
├── tsconfig.json              <- configuration of the typescript project (ts-node, which runs the tasks defined in gulpfile.ts)
├── tslint.json                <- tslint configuration
├── typings                    <- typings directory. Contains all the external typing definitions defined with typings
├── typings.json
└── appveyor.yml

Contributors

mgechev	ludohenin	d3viant0ne	Shyam-Chen	tarlepp	NathanWalker

TheDonDope	nareshbhatia	hank-ehly	kiuka	jesperronn	vyakymenko

njs50	aboeglin	ryzy	gkalpak	sfabriece	pgrzeszczak

eppsilon	natarajanmca11	JayKan	jerryorta-dev	JakePartusch	larsthorup

domfarolino	LuxDie	tsm91	juristr	e-oz	JohnCashmore

ouq77	devanp92	hAWKdv	c-ice	markharding	gotenxds

ojacquemart	Nightapes	evanplaice	TuiKiken	turbohappy	jvitor83

troyanskiy	ip512	Green-Cat	Yonet	tiagomapmarques	yassirh

amaltsev	taguan	sonicparke	brendanbenson	brian428	briantopping

ckapilla	cadriel	dszymczuk	gvsdan	dstockhammer	dwido

totev	nosachamos	koodikindral	allenhwkim	alexweber	hpinsley

jeffbcross	johnjelinek	justindujardin	lihaibh	nulldev07	tandu

inkidotcom	daixtrose	mjwwit	ocombe	gdi2290	typekpb

philipooo	redian	Bigous	robbatt	robertpenner	sclausen

heavymery	tapas4java	vincentpalita	Yalrafih	billsworld	blackheart01

butterfieldcons	jgolla	ultrasonicsoft	Brooooooklyn

Wiki Contributors

Here are all the awesome guys who are helping to make the project's wiki even better!

37  Minko Gechev
22  Clayton K. N. Passos
15  Shyam-Chen
14  Vincent van Proosdij
 8  Christian Dobert
 8  Robert van Kints
 8  matthew harwood
 6  Ludovic HENIN
 5  Attila Egyed
 3  Stefan Schüller
 3  Patrick Hillert
 3  Ezequiel Cicala
 2  Nathan Walker
 2  Yannick Koehler
 2  Giovanni Candido da Silva
 2  Simon Hampton
 2  Cy Klassen
 2  Joshua Wiens
 2  Drake Wilson
 2  Dinsitro
 1  zcsongor
 1  BouncingBit
 1  Brian Kotek
 1  Chris Kapilla
 1  Dang Tung
 1  Eddie Sun
 1  Enrico Secondulfo
 1  Eugene Serkin
 1  Ishara Samantha
 1  Myrmex
 1  Pol Stafford
 1  Raphael Schmitt
 1  Sebastian Fuss
 1  Sebastien de Salvador
 1  The Ult
 1  graham
 1  kiuka
 1  Ankit Kamboj

Change Log

You can follow the Angular 2 change log here.

License

MIT