Skip to content

Latest commit

 

History

History
741 lines (614 loc) · 56.9 KB

README.md

File metadata and controls

741 lines (614 loc) · 56.9 KB
Raw

Introduction

Greenkeeper badge

Angular Style Guide Build Status Build Status Join the chat at https://gitter.im/mgechev/angular2-seed Dependency Status devDependency Status

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

Warning: If you're just getting started with the entire JavaScript ecosystem then Angular Seed might not be the best choice for you. The project provides scalable approach for building Angular applications but you may face difficulties configuring this highly customizable solution. In such case we recommend the Angular CLI.

angular-seed provides the following features:

  • Allows you to painlessly update the seed tasks of already existing project.
  • Supports multiple Angular applications with shared codebase in a single instance of the seed.
  • Official Angular i18n support.
  • Ready to go, statically typed build system using gulp for working with TypeScript.
  • Production and development builds.
  • Ahead-of-Time compilation support.
  • Tree-Shaking production builds with Rollup.
  • Uses codelyzer for static code analysis, which verifies that the project follows practices from the Angular style guide.
  • 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.
  • Provides full Docker support for both development and production environment
  • Support for Angular Mobile Toolkit
  • Allows you to analyze the space usage of created bundles by using source-map-explorer

How to start

Note that this seed project requires node v4.x.x or higher and npm 2.14.7 but in order to be able to take advantage of the complete functionality we strongly recommend node >=v6.5.0 and npm >=3.10.3.

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/angular-seed.git
$ cd angular-seed

# install the project's dependencies
$ npm install
# fast install (via Yarn, https://yarnpkg.com)
$ yarn install  # or yarn

# watches your files and uses livereload by default
$ npm start

# generate api documentation
$ npm run compodoc
$ npm run serve.compodoc


# to start deving with livereload site and coverage as well as continuous testing
$ npm run start.deving

# dev build
$ npm run build.dev
# prod build, will output the production application in `dist/prod`
# the produced code can be deployed (rsynced) to a remote server
$ npm run build.prod

# dev build of multiple applications (by default the value of --app is "app")
$ npm start -- --app baz
$ npm start -- --app foo
$ npm start -- --app bar

Does not rely on any global dependencies.

How to start with AoT compilation

Note that AoT compilation requires node v6.5.0 or higher and npm 3.10.3 or higher.

In order to start the seed with AoT use:

# prod build with AoT compilation, will output the production application in `dist/prod`
# the produced code can be deployed (rsynced) to a remote server
$ npm run build.prod.aot

Tree-shaking with Rollup

This application provides full support for tree-shaking your production builds with Rollup, which can drastically reduce the size of your application. This is the highest level of optimization currently available.

To run this optimized production build, use:

# prod build with AoT compilation and Rollup tree-shaking, will output the production application in `dist/prod`
# the produced code can be deployed (rsynced) to a remote server
$ npm run build.prod.rollup.aot

Your project will be compiled ahead of time (AOT), and then the resulting bundle will be tree-shaken and minified. During the tree-shaking process Rollup statically analyses your code, and your dependencies, and includes the bare minimum in your bundle.

Notes

  • Beware of non-static/side-effectful imports. These cannot be properly optimized. For this reason, even though tree-shaking is taking place the developer still needs to be careful not to include non-static imports that are unnecessary, as those referenced imports will always end up in final bundle. Special attention should be given to RxJs, which makes heavy use of non-static/side-effectful imports: make sure you only add the operators you use, as any added operators will be included in your final production bundle.
  • UMD modules result in code that cannot be properly optimized. For best results, prefer ES6 modules whenever possible. This includes third-party dependencies: if one is published in both UMD and ES6 modules, go with the ES6 modules version.
  • During a production build, CommonJs modules will be automatically converted to ES6 modules. This means you can use them and/or require dependencies that use them without any issues.

Internationalization

Put i18n attribute to your html tag to mark it for translation, more information here: https://angular.io/docs/ts/latest/cookbook/i18n.html

Create a translation source file

# Your translation file will be generated here `dist/locale`
$ npm run i18n

Production build with your language

# Build prod app with the language file `dist/locale/messages.en.xlf`
$ npm run build.prod.rollup.aot -- --lang en

Dockerization

The application provides full Docker support. You can use it for both development and production builds and deployments.

Please note that prod and dev are built into their own separate image, which can lead to unexpected differences in the npm dependencies and the state of the sources in the container, if you are not familiar with Docker. See below.

Development build and deployment

The dev image only contains the npm libraries installed, but not the sources. The sources are mounted at runtime, via a docker shared volume, which allows for the live-reload feature to work.

To start the container, use:

$ docker-compose -f docker-compose.dev.yml up -d   # optional: --build, see below

Now open your browser at http://localhost:5555

Production build and deployment

The prod image serves the minified app (sources compiles with a minimal set of dependencies), via an Nginx server. It is self-contained, and can therefore be pushed to a Docker registry to be deployed somewhere else easily.

To start the container, use:

$ docker-compose -f docker-compose.prod.yml up -d   # optional: --build, see below

Now open your browser at http://localhost:5555

Updating dependencies and sources

If you are not already familiar with Docker, please note that for both Dev and Prod docker environments, updates to npm dependencies will be visible only after re-building the image and restarting a new container from it.

In Dev environment, this only applies to npm dependencies, since the sources are mounted as a shared directory. In Prod environment, this applies to any change in the project.

To force docker-compose to rebuild the image before starting the container, use the --build flag:

$ docker-compose -f docker-compose.dev.yml up -d --build

Analyzing the space usage of the app

You can analyze the bundle with source-map-explorer. It creates a html chart with a file by default, but output can also be json or tsv.

Run the following:

$ npm run sme.prod # or respectively sme.prod.aot / sme.prod.rollup.aot
# You can specify the output format by passing the `sme-out-format` parameter
$ npm run sme.prod.aot -- --sme-out-format json # or html / tsv

Table of Contents

Configuration

Default application server configuration

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

Configure at runtime

$ npm start -- --port 8080 --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 files dev.ts or prod.ts in./tools/env/. The name of the file is environment you want to use.

The environment can be specified by using:

$ npm start -- --env-config ENV_NAME

Currently the ENV_NAMEs are dev, prod, staging, but you can simply add a different file "ENV_NAME.ts". 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.

How to update?

git remote add upstream https://github.com/mgechev/angular-seed
git pull upstream master

Running tests

$ npm test

# Development. Your app will be watched by karma
# on each change all your specs will be executed.
$ npm run test.watch
# NB: The command above might fail with a "EMFILE: too many open files" error.
# Some OS have a small limit of opened file descriptors (256) by default
# and will result in the EMFILE error.
# You can raise the maximum of file descriptors by running the command below:
$ ulimit -n 10480


# 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
# Make sure you do have Java in your PATH (required for webdriver)

# npm install webdriver-manager <- Install this first for e2e testing
# 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 shows examples of how this seed can be expanded to support:

  • ngrx/store RxJS powered state management, inspired by Redux
  • ngrx/effects Side effect model for @ngrx/store
  • ngx-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 Angular 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.
  • Electron cross platform desktop apps (Mac, Windows and Linux).

You may use it to learn how to extend this seed for your own use cases.

Examples

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

Directory Structure

.
├── .docker
│   ├── dist-build.development.dockerfile  <- Dockerfile for development environment
│   └── dist-build.production.dockerfile   <- Dockerfile for production environment
├── .dockerignore              <- ignore file for the docker builds
├── LICENSE
├── README.md
├── appveyor.yml
├── docker-compose.production.yml  <- docker-compose file for production environment
├── docker-compose.yml.        <- docker-compose file for development environment
├── 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
│   ├── client
│   │   ├── app
│   │   │   ├── about
│   │   │   │   ├── about-routing.module.ts
│   │   │   │   ├── about.component.css
│   │   │   │   ├── about.component.html
│   │   │   │   ├── about.component.spec.ts
│   │   │   │   ├── about.component.ts
│   │   │   │   └── about.module.ts
│   │   │   ├── app-routing.module.ts
│   │   │   ├── app.component.css
│   │   │   ├── app.component.html
│   │   │   ├── app.component.spec.ts
│   │   │   ├── app.component.ts
│   │   │   ├── app.module.ts
│   │   │   ├── home
│   │   │   │   ├── home-routing.module.ts
│   │   │   │   ├── home.component.css
│   │   │   │   ├── home.component.html
│   │   │   │   ├── home.component.spec.ts
│   │   │   │   ├── home.component.ts
│   │   │   │   └── home.module.ts
│   │   │   ├── i18n.providers.ts
│   │   │   ├── main-prod.ts
│   │   │   ├── main.ts
│   │   │   ├── operators.ts
│   │   │   └── shared
│   │   │       ├── config
│   │   │       │   └── env.config.ts
│   │   │       ├── name-list
│   │   │       │   ├── name-list.service.spec.ts
│   │   │       │   └── name-list.service.ts
│   │   │       ├── navbar
│   │   │       │   ├── navbar.component.css
│   │   │       │   ├── navbar.component.html
│   │   │       │   └── navbar.component.ts
│   │   │       ├── shared.module.ts
│   │   │       └── toolbar
│   │   │           ├── toolbar.component.css
│   │   │           ├── toolbar.component.html
│   │   │           └── toolbar.component.ts
│   │   ├── assets
│   │   │   ├── data.json
│   │   │   ├── favicon
│   │   │   │   ├── favicon-DEV.ico
│   │   │   │   └── favicon-PROD.ico
│   │   │   └── svg
│   │   │       └── more.svg
│   │   ├── css
│   │   │   └── main.css
│   │   ├── index.html
│   │   ├── ngsw-config.json
│   │   ├── system-config.ts
│   │   └── tsconfig.json
│   └── e2e
│       ├── specs
│       │   ├── about.component.e2e-spec.ts
│       │   ├── app.component.e2e-spec.ts
│       │   └── home.component.e2e-spec.ts
│       └── tsconfig.json
├── test-config.js             <- testing configuration
├── test-main.js               <- karma test launcher
├── tools
│   ├── README.md              <- build documentation
│   ├── config
│   │   ├── banner-256.txt
│   │   ├── banner.txt
│   │   ├── project.config.ts  <- configuration of the specific project
│   │   ├── project.tasks.json <- override composite gulp tasks
│   │   ├── seed.config.ts     <- generic configuration of the seed project
│   │   ├── seed.config.interfaces.ts
│   │   ├── seed.tasks.json    <- default composite gulp tasks
│   │   └── seed.tslint.json   <- generic tslint 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
│   │   ├── env-config.interface.ts
│   │   └── prod.ts
│   ├── manual_typings
│   │   ├── project            <- manual ambient typings for the project
│   │   │   └── sample.package.d.ts
│   │   └── seed               <- seed manual ambient typings
│   │       ├── autoprefixer.d.ts
│   │       ├── cssnano.d.ts
│   │       ├── express-history-api-fallback.d.ts
│   │       ├── istream.d.ts
│   │       ├── karma.d.ts
│   │       ├── merge-stream.d.ts
│   │       ├── open.d.ts
│   │       ├── operators.d.ts
│   │       ├── slash.d.ts
│   │       ├── systemjs-builder.d.ts
│   │       └── tildify.d.ts
│   ├── tasks                  <- gulp tasks
│   │   ├── assets_task.ts
│   │   ├── css_task.ts
│   │   ├── 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.bundle.rxjs.ts
│   │   │   ├── build.bundles.app.aot.ts
│   │   │   ├── build.bundles.app.rollup.aot.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.aot.ts
│   │   │   ├── build.js.prod.rollup.aot.ts
│   │   │   ├── build.js.prod.ts
│   │   │   ├── build.js.test.ts
│   │   │   ├── build.sme.prod.aot.ts
│   │   │   ├── build.sme.prod.rollup.aot.ts
│   │   │   ├── build.sme.prod.ts
│   │   │   ├── build.tools.ts
│   │   │   ├── check.tools.ts
│   │   │   ├── check.versions.ts
│   │   │   ├── clean.all.ts
│   │   │   ├── clean.coverage.ts
│   │   │   ├── clean.dev.ts
│   │   │   ├── clean.e2e.ts
│   │   │   ├── clean.prod.ts
│   │   │   ├── clean.sme.ts
│   │   │   ├── clean.tools.ts
│   │   │   ├── clear.files.ts
│   │   │   ├── compile.ahead.prod.ts
│   │   │   ├── copy.prod.rollup.aot.ts
│   │   │   ├── copy.prod.ts
│   │   │   ├── e2e.ts
│   │   │   ├── generate.manifest.ts
│   │   │   ├── i18n.build.ts
│   │   │   ├── i18n.merge.ts
│   │   │   ├── karma.run.ts
│   │   │   ├── karma.run.with_coverage.ts
│   │   │   ├── karma.run.without_coverage.ts
│   │   │   ├── karma.watch.ts
│   │   │   ├── minify.bundles.ts
│   │   │   ├── minify.index.ts
│   │   │   ├── noop.ts
│   │   │   ├── print.banner.ts
│   │   │   ├── serve.coverage.ts
│   │   │   ├── serve.coverage.watch.ts
│   │   │   ├── serve.docs.ts
│   │   │   ├── server.prod.ts
│   │   │   ├── server.start.ts
│   │   │   ├── start.deving.ts
│   │   │   ├── sw.manifest.static.ts
│   │   │   ├── test.watch.ts
│   │   │   ├── transpile.bundles.rollup.aot.ts
│   │   │   ├── tslint.ts
│   │   │   ├── watch.dev.ts
│   │   │   ├── watch.e2e.ts
│   │   │   ├── watch.test.ts
│   │   │   └── webdriver.ts
│   │   ├── task.ts
│   │   └── typescript_task.ts
│   ├── utils                  <- build utils
│   │   ├── project            <- project specific gulp utils
│   │   │   └── sample_util.ts
│   │   ├── project.utils.ts
│   │   ├── seed               <- seed specific gulp utils
│   │   │   ├── build_optimizer.ts
│   │   │   ├── clean.ts
│   │   │   ├── code_change_tools.ts
│   │   │   ├── karma.start.ts
│   │   │   ├── server.ts
│   │   │   ├── sme.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
└── yarn.lock

Contributors

mgechev ludohenin d3viant0ne Shyam-Chen NathanWalker Nightapes
mgechev ludohenin d3viant0ne Shyam-Chen NathanWalker Nightapes
tarlepp karlhaas TheDonDope robstoll nareshbhatia hank-ehly
tarlepp karlhaas TheDonDope robstoll nareshbhatia hank-ehly
kiuka fr-esco vyakymenko jesperronn daniru patrickmichalina
kiuka fr-esco vyakymenko jesperronn daniru patrickmichalina
nhutcorp aboeglin netstart eppsilon sasikumardr nulldev07
nhutcorp aboeglin netstart eppsilon sasikumardr nulldev07
gkalpak markwhitfeld Karasuni sfabriece ryzy jerryorta-dev
gkalpak markwhitfeld Karasuni sfabriece ryzy jerryorta-dev
treyrich natarajanmca11 e-oz nosachamos pgrzeszczak alllx
treyrich natarajanmca11 e-oz nosachamos pgrzeszczak alllx
LuxDie JakePartusch JayKan JohnCashmore larsthorup admosity
LuxDie JakePartusch JayKan JohnCashmore larsthorup admosity
Doehl irsick StefanKoenen amedinavalencia odk211 troyanskiy
Doehl irsick StefanKoenen amedinavalencia odk211 troyanskiy
tsm91 domfarolino juristr jvitor83 ouq77 ahmadqarshi
tsm91 domfarolino juristr jvitor83 ouq77 ahmadqarshi
turbohappy gotenxds devanp92 DmitriyPotapov fisenkodv evanplaice
turbohappy gotenxds devanp92 DmitriyPotapov fisenkodv evanplaice
JunaidZA c-ice markharding ojacquemart rafaelss95 rajeev-tripathi
JunaidZA c-ice markharding ojacquemart rafaelss95 rajeev-tripathi
ArnaudPel TuiKiken vogloblinsky edud69 idready zbarbuto
ArnaudPel TuiKiken vogloblinsky edud69 idready zbarbuto
Yonet Green-Cat ip512 joshboley Marcelh1983 pbazurin-softheme
Yonet Green-Cat ip512 joshboley Marcelh1983 pbazurin-softheme
Bigous salemdar alexweber allenhwkim hellofornow yassirh
Bigous salemdar alexweber allenhwkim hellofornow yassirh
amaltsev tomlobato taguan bbarry bbogdanov sonicparke
amaltsev tomlobato taguan bbarry bbogdanov sonicparke
brendanbenson brian428 briantopping ckapilla cadriel Cselt
brendanbenson brian428 briantopping ckapilla cadriel Cselt
dszymczuk dmurat peah90 dstockhammer madcalfus dwido
dszymczuk dmurat peah90 dstockhammer madcalfus dwido
totev JimbeanZN emilio-simoes ericdoerheit gp187 gsamokovarov
totev JimbeanZN emilio-simoes ericdoerheit gp187 gsamokovarov
koodikindral hkashlan hpinsley NN77 isidroamv JohnnyQQQQ
koodikindral hkashlan hpinsley NN77 isidroamv JohnnyQQQQ
jeffbcross Drane johnjelinek JunusErgin justindujardin karlhiramoto
jeffbcross Drane johnjelinek JunusErgin justindujardin karlhiramoto
lihaibh Brooooooklyn tandu inkidotcom mpetkov daixtrose
lihaibh Brooooooklyn tandu inkidotcom mpetkov daixtrose
MathijsHoogland maxklenk mjwwit oferze ocombe gdi2290
MathijsHoogland maxklenk mjwwit oferze ocombe gdi2290
typekpb pavlovich philipooo redian robbatt robertpenner
typekpb pavlovich philipooo redian robbatt robertpenner
Sjiep RoxKilly siovene SamVerschueren sclausen heavymery
Sjiep RoxKilly siovene SamVerschueren sclausen heavymery
na-oma tapas4java tsvetomir valera-rozuvan vincentpalita VladimirMakaev
na-oma tapas4java tsvetomir valera-rozuvan vincentpalita VladimirMakaev
Yalrafih arioth billsworld blackheart01 butterfieldcons danielcrisp
Yalrafih arioth billsworld blackheart01 butterfieldcons danielcrisp
gforceg jgolla locinus omerfarukyilmaz ZuSe rossedfort
gforceg jgolla locinus omerfarukyilmaz ZuSe rossedfort
ruffiem savcha tobiaseisenschenk ultrasonicsoft Falinor
ruffiem savcha tobiaseisenschenk ultrasonicsoft Falinor

Wiki Contributors

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

60  Minko Gechev
35  Clayton K. N. Passos
15  Shyam-Chen
14  Vincent van Proosdij
 8  Robert van Kints
 8  matthew harwood
 8  Christian Dobert
 7  Neo Minchul Chae
 6  Ludovic HENIN
 6  ruffiem
 5  Attila Egyed
 5  hhubik
 4  Chris Kapilla
 4  davidgfolch
 4  gforceg
 4  Brian Kotek
 3  Ezequiel Cicala
 3  Stefan Schüller
 3  Kirill Zdornyy
 3  Patrick Hillert
 3  Robert Stoll
 2  Dinsitro
 2  Brooke Smith
 2  Joshua Wiens
 2  Daniele Zurico
 2  Amal Shehu
 2  Cy Klassen
 2  Nathan Walker
 2  Simon Hampton
 2  omerfarukyilmaz
 2  Hank Ehly
 2  zealitude
 2  Paul Davis
 2  valentin
 2  Giovanni Candido da Silva
 2  Drake Wilson
 2  Yannick Koehler
 1  jovermier
 1  kiuka
 1  mcchae7
 1  neridonk
 1  samuelfernandez
 1  silicakes
 1  zcsongor
 1  Adam Johannesmeyer
 1  陳彥澄
 1  Alexander Yamkov
 1  Ameer Nuri
 1  Ankit Kamboj
 1  BouncingBit
 1  Charlie Hua
 1  Dang Tung
 1  EBIA
 1  Eddie Sun
 1  Enrico Secondulfo
 1  Eugene Serkin
 1  Fede Guzmán
 1  Frido Koch
 1  Ishara Samantha
 1  Jack Morrissey
 1  Jesper Rønn-Jensen
 1  José Rebelo
 1  Karasu
 1  Marc-André Barbeau
 1  Mathias Døhl
 1  Myrmex
 1  Pol Stafford
 1  Raphael Schmitt
 1  Sebastian Fuss
 1  Sebastien de Salvador
 1  Shyam Chen
 1  Simon Altschuler
 1  Sylvain Francois
 1  The Ult
 1  Valentyn Yakymenko
 1  Vivin Antony
 1  Yen-cheng Chen, 陳彥澄
 1  Yonet
 1  Zakhar Gulchak
 1  ganesansays
 1  geo101
 1  graham

Change Log

You can follow the Angular change log here.

License

MIT