Angular2 Start

An Angular 2 starter project written in Typescript 2 and featuring (Ahead of Time Compile, Router, Forms, Services, Async/Lazy Routes, Directives, Unit tests and E2E tests), Bootstrap 4, Sass Hot Module Replacement, Prerendering, Karma, Protractor, Jasmine, Saucelabs, CircleCI, NodeJS, Istanbul, Codelyzer, @types, Tslint and Webpack 2.

If you're looking for Angular 1.x please use angular-start

This project structure is heavily based on the Angular 2 Webpack Starter skeleton for a typical Angular 2/Webpack 2 application.

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 2 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 practices in file and application organization for Angular 2.
Ready to go build system using Webpack for working with TypeScript.
Angular 2 examples that are ready to go when experimenting with Angular 2.
A great Angular 2 seed repo for anyone who wants to start their project.
Ahead of Time (AoT) compile for rapid page loads of your production builds.
Tree shaking to automatically remove unused code from your production bundle.
Testing Angular 2 code with Jasmine and Karma.
Coverage with Istanbul and Karma
End-to-end Angular 2 code using Protractor and Saucelabs.
Type manager with @types
Hot Module Replacement with Webpack and @angularclass/hmr and @angularclass/hmr-loader
Sass styling compilation
Bootstrap 4
Angular 4 support via changing package.json and any future Angular versions
Prerendering of static site pages at build time. Useful for sites with static content and a low number of pages.

Quick start

Make sure you have Node version >= 5.0 and NPM >= 3

Clone/Download the repo then edit app.ts inside /src/app/app.ts

# clone our repo
# --depth 1 removes all but one .git commit history
git clone --depth 1 https://github.com/thisissoon/angular2-start.git

# change directory to our repo
cd angular2-start

# install the repo with npm
npm install

# start the server
npm start

# use Hot Module Replacement
npm run server:dev:hmr

go to http://0.0.0.0:3000 or http://localhost:3000 in your browser

File Structure
Getting Started
Configuration
Prerendering
Contributing
TypeScript
@Types
Frequently asked questions
License

File Structure

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-start/
 ├──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.dev.conf.js * protractor config for our end-to-end tests when running locally
 |   ├──protractor.ci.conf.js  * protractor config for our end-to-end tests when running via saucelabs
 │   ├──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.browser.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
 │   │   └──humans.txt         * for humans to know who the developers are
 │   │
 │   └──scss/                  * Source code for sass global styles
 │       ├──lg/                * styles for device greater than 992px width
 │       ├──md/                * styles for device greater than 768px width
 │       ├──xl/                * styles for device greater than 1200px width
 │       ├──xs/                * styles for all devices
 │       └──main.scss          * entry file for all global sass styles
 │
 ├──tslint.json                * typescript lint config
 ├──typedoc.json               * typescript documentation generator
 ├──tsconfig.json              * config that webpack uses for typescript
 ├──package.json               * what npm uses to manage it's dependencies
 └──webpack.config.js          * webpack main configuration file

Getting Started

Dependencies

What you need to run this app:

node and npm (brew install node)
Optionally you can use yarn (brew install yarn) to install node modules
Ensure you're running the latest versions Node v4.x.x+ (or v5.x.x) and NPM 3.x.x+

If you have nvm installed, which is highly recommended (brew install nvm) you can do a nvm install --lts && nvm use in $ to run with the latest Node LTS. You can also have this zsh done for you automatically

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)
typescript (npm install --global typescript)

Installing

fork this repo
clone your fork
npm install webpack-dev-server rimraf webpack -g to install required global dependencies
npm install to install all dependencies or yarn
npm run server to start the dev server in another tab

Running the app

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://0.0.0.0:3000 (or if you prefer IPv6, if you're using express server, then it's http://[::1]:3000/).

server

# development
npm run server
# production
npm run build:prod
npm run server:prod

Other commands

build files

# development
npm run build:dev
# production (jit)
npm run build:prod
# AoT
npm run build:aot

hot module replacement

npm run server:dev:hmr

watch and build files

npm run watch

run unit tests

npm run test

watch and run our tests

npm run watch:test

run end-to-end tests

# this will start a test server and launch Protractor
npm run test:e2e

run webdriver (for end-to-end)

npm run ci

run Protractor's elementExplorer (for end-to-end)

npm run webdriver:start
# in another terminal
npm run e2e:live

build Docker

npm run build:docker

Prerendering

Generating static site pages at build time can be enabled in config/webpack.prod.ts by uncommenting the Prerender Spa Plugin block in the plugins section and then adding all applicable routes to the array. This plugin will generate a static version of the sites pages at build time.

Configuration

Configuration files live in config/ we are currently using webpack, karma, and protractor for different stages of your application

AoT Don'ts

The following are some things that will make AoT compile fail.

Don’t use require statements for your templates or styles, use styleUrls and templateUrls, the angular2-template-loader plugin will change it to require at build time.
Don’t use default exports.
Don’t use form.controls.controlName, use form.get(‘controlName’)
Don’t use control.errors?.someError, use control.hasError(‘someError’)
Don’t use functions in your providers, routes or declarations, export a function and then reference that function name
Inputs, Outputs, View or Content Child(ren), Hostbindings, and any field you use from the template or annotate for Angular should be public

Contributing

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

TypeScript

To take full advantage of TypeScript with autocomplete you would have to install it globally and use an editor with the correct TypeScript plugins.

Use latest TypeScript compiler

TypeScript 2 includes everything you need. Make sure to upgrade, even if you installed TypeScript previously.

npm install --global typescript

Use a TypeScript-aware editor

We have good experience using these editors:

Visual Studio Code
Webstorm 10
Atom with TypeScript plugin
Sublime Text with Typescript-Sublime-Plugin

Visual Studio Code + Debugger for Chrome

Install Debugger for Chrome and see docs for instructions to launch Chrome

The included .vscode automatically connects to the webpack development server on port 3000.

Types

When you include a module that doesn't include Type Definitions inside of the module you can include external Type Definitions with @types

i.e, to have youtube api support, run this command in terminal:

npm i @types/youtube @types/gapi @types/gapi.youtube

In some cases where your code editor doesn't support Typescript 2 yet or these types weren't listed in tsconfig.json, add these to "src/custom-typings.d.ts" to make peace with the compile check:

import '@types/gapi.youtube';
import '@types/gapi';
import '@types/youtube';

Custom Type Definitions

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 @types

npm install @types/node
npm install @types/lodash

If you can't find the type definition in the registry we can make an ambient definition in this file for now. For example

declare module "my-module" {
  export function doesSomething(value: string): string;
}

If you're prototyping and you will fix the types later you can also declare it as type any

declare var assert: any;
declare var _: any;
declare var $: any;

If you're importing a module that uses Node.js modules which are CommonJS you need to import as

import * as _ from 'lodash';

Frequently asked questions

What's the current browser support for Angular 2?
- Please view the updated list of browser support for Angular 2
Why is my service, aka provider, is not injecting parameter correctly?
- Please use @Injectable() for your service for typescript to correctly attach the metadata (this is a TypeScript problem)
How do I run protractor with node 0.12.x?
- please check out this repo to use the old version of protractor #146
Where do I write my tests?
- You can write your tests next to your component files. See /src/app/+home/home.component.ts
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 ./dist/
How to use sass for css?
loaders: ['raw-loader','sass-loader'] and @Component({ styleUrls: ['./filename.scss'] }) see issue #136
How do I test a Service?
See issue #130
How do I add vscode-chrome-debug support?
The VS Code chrome debug extension support can be done via launch.json see issue #144
How do I make the repo work in a virtual machine?
You need to use 0.0.0.0 so revert these changes #205
What are the naming conventions for Angular 2?
please see issue #185 and PR 196
How do I include bootstrap or jQuery?
please see issue #215 and #214
How do I async load a component?
see wiki How-do-I-async-load-a-component-with-AsyncRoute
Error: Cannot find module 'tapable'
Remove node_modules/ and run npm cache clean then npm install
What about Webpack 2?
If you're looking for Webpack 2 version then see the experimental version that will be merged soon.
How do I turn on Hot Module Replacement
Run npm run server:dev:hmr
RangeError: Maximum call stack size exceeded
This is a problem with minifying Angular 2 and it's recent JIT templates. If you set mangle to false then you should be good.
Why is the size of my app larger in development?
We are using inline source-maps and hot module replacement which will increase the bundle size.
node-pre-gyp ERR in npm install (Windows)
install Python x86 version between 2.5 and 3.0 on windows see issue #626
Error:Error: Parse tsconfig error [{"messageText":"Unknown compiler option 'lib'.","category":1,"code":5023},{"messageText":"Unknown compiler option 'strictNullChecks'.","category":1,"code":5023},{"messageText":"Unknown compiler option 'baseUrl'.","category":1,"code":5023},{"messageText":"Unknown compiler option 'paths'.","category":1,"code":5023},{"messageText":"Unknown compiler option 'types'.","category":1,"code":5023}]
remove node_modules/typescript and run npm install typescript@beta. This repo now uses ts 2.0
"There are multiple modules with names that only differ in casing"
change c:\[path to angular2-webpack-starter] to C:\[path to angular2-webpack-starter] see 926#issuecomment-245223547

License

MIT

PhamVanThuan/angular2-start