Introduction

A seed project for Angular 2 apps.

It is something similar to the AngularJS Quick Start but does the entire build with gulp.

How to start

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

git clone https://github.com/mgechev/angular2-seed.git
cd angular2-seed
npm install       # or `npm run reinstall` if you get an error
npm start         # start with --env dev
npm run docs      # api document for app

Using the experimental hot loader support

If you want to try the experimental hot loading support use:

npm start -- --hot-loader true

Note that the hot loader is still in experimental phase of development and there are some missing features. If you experience any issues with it report them at here.

Does not rely on any global dependencies.

Table of Content

• Introduction
• How to start
  • Using the experimental hot loader support
• Table of Content
• Directory Structure
• Configuration
• How to extend?
  • Adding custom libraries
  • Adding custom gulp task
• Running test
• Contributing
• Examples
• Contributors
• Change Log
• License

Directory Structure

.
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── app
│   ├── assets
│   │   ├── img
│   │   │   └── smile.png
│   │   └── main.css
│   ├── bootstrap.ts
│   ├── components
│   │   ├── about
│   │   │   ├── about.html
│   │   │   ├── about.ts
│   │   │   └── about_spec.ts
│   │   ├── app
│   │   │   ├── app.css
│   │   │   ├── app.html
│   │   │   ├── app.ts
│   │   │   └── app_spec.ts
│   │   └── home
│   │       ├── home.css
│   │       ├── home.html
│   │       ├── home.ts
│   │       └── home_spec.ts
│   ├── hot_loader_bootstrap.ts
│   ├── index.html
│   └── services
│       ├── name_list.ts
│       └── name_list_spec.ts
├── appveyor.yml
├── dist
├── gulpfile.ts
├── karma.conf.js
├── package.json
├── test-main.js
├── tools
│   ├── config.ts
│   ├── tasks
│   │   ├── build.assets.dev.ts
│   │   ├── build.assets.prod.ts
│   │   ├── build.bundles.ts
│   │   ├── build.deps.ts
│   │   ├── build.docs.ts
│   │   ├── build.html_css.prod.ts
│   │   ├── build.index.ts
│   │   ├── build.js.dev.ts
│   │   ├── build.js.prod.ts
│   │   ├── build.sass.dev.ts
│   │   ├── build.test.ts
│   │   ├── check.versions.ts
│   │   ├── clean.ts
│   │   ├── karma.start.ts
│   │   ├── npm.ts
│   │   ├── serve.docs.ts
│   │   ├── server.start.ts
│   │   ├── tsd.ts
│   │   ├── tslint.ts
│   │   ├── watch.dev.ts
│   │   ├── watch.serve.ts
│   │   └── watch.test.ts
│   ├── typings
│   ├── utils
│   │   ├── code_change_tools.ts
│   │   ├── server.ts
│   │   ├── tasks_tools.ts
│   │   ├── template_injectables.ts
│   │   └── template_locals.ts
│   └── utils.ts
├── tsconfig.json
├── tsd.json
└── tslint.json

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/

How to extend?

Adding custom libraries

If you want to use your custom libraries:

npm install my-library --save
vim tools/config.ts

Add reference to the installed library in NPM_DEPENDENCIES:

export const NPM_DEPENDENCIES = [
  { src: 'systemjs/dist/system-polyfills.js', dest: LIB_DEST },


  { src: 'bootstrap/dist/css/bootstrap.min.css', inject: true, dest: CSS_DEST }
  // ...
  { src: 'my-library/dist/bundle.js', inject: true, dest: LIB_DEST }
];

• src - relative to node_modules
• inject - indicates whether the library should be injected (if not you have to include it manually in index.html)
• dest - your library will be copied to this location. Used for the production build.

Do not forget to add a reference to the type definition inside the files where you use your custom library.

Adding custom gulp task

In this example we are going to add SASS support to the seed's dev build:

1. Install gulp-sass as dependency:

npm install gulp-sass --save-dev

2. Add type definitions:

# Note: tsd MUST be installed as global
tsd install gulp-sass --save

3. Add SASS task at ./tools/tasks/build.sass.dev.ts:

import {join} from 'path';
import {APP_SRC, APP_DEST} from '../config';

export = function buildSassDev(gulp, plugins, option) {
  return function () {
    return gulp.src(join(APP_SRC, '**', '*.scss'))
      .pipe(plugins.sass().on('error', plugins.sass.logError))
      .pipe(gulp.dest(APP_DEST));
  };
}

4. Add build.sass.dev to your dev pipeline:

// gulpfile.ts
...
// --------------
// Build dev.
gulp.task('build.dev', done =>
  runSequence('clean.dist',
              'tslint',
              'build.sass.dev',
              'build.assets.dev',
              'build.js.dev',
              'build.index',
              done));
...

Running test

npm test

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

# e2e (aka. end-to-end, integration) - In three different shell windows
npm start
# npm run webdriver-update <- You may need to run this the first time
npm run webdriver-start
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.

Examples

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

• https://github.com/justindujardin/angular2-seed - integration with ng2-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.

Contributors

mgechev	ludohenin	tarlepp	NathanWalker	aboeglin	jesperronn

ryzy	natarajanmca11	larsthorup	jerryorta-dev	JakePartusch	ouq77

TuiKiken	justindujardin	dwido	sclausen	johnjelinek	dstockhammer

lihaibh	Brooooooklyn	tandu	markharding	mjwwit	ocombe

gdi2290	typekpb	philipooo	redian	robertpenner	evanplaice

butterfieldcons	jgolla	ultrasonicsoft

Change Log

You can follow the Angular 2 change log here.

License

MIT