Repository files navigation

An Angular starter kit featuringAngular 6,Ahead of Time Compile,Router,Forms,Http,Services,Tests,E2E),Karma,Protractor,Jasmine,Istanbul,TypeScript,@types,TsLint,Codelyzer,Hot Module Replacement, andWebpack.

If you're looking for Angular 1.x please useNG6-starterIf you're looking to learn about Webpack and ES6 Build Tools check outES6-build-toolsIf you're looking to learn TypeScript seeTypeStrong/learn-typescriptIf you're looking for something easier to get started with then see the angular-seed that I also maintaingdi2290/angular-seed

This seed repo serves as an Angular starter for anyone looking to get up and running with Angular and TypeScript fast. Using aWebpack 4 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.
• Ready to go build system using Webpack for working with TypeScript.
• Angular examples that are ready to go when experimenting with Angular.
• A great Angular 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 code with Jasmine and Karma.
• Coverage with Istanbul and Karma
• End-to-end Angular app testing using Protractor.
• Type manager with @types
• Hot Module Replacement with Webpack and@gdi2290/hmr and@gdi2290/hmr-loader

Make sure you have Node version >= 8.0 and (NPM >= 5 orYarn )

Clone/Download the repo then editapp.component.ts inside/src/app/app.component.ts

# clone our repo# --depth 1 removes all but one .git commit historygit clone --depth 1 https://github.com/gdi2290/angular-starter.git# change directory to our repocd angular-starter# install the repo with npmnpm install# start the servernpm start# use Hot Module Replacementnpm run server:dev:hmr# if you're in China use cnpm# https://github.com/cnpm/cnpm

go tohttp://0.0.0.0:3000 orhttp://localhost:3000 in your browser

• File Structure
• Getting Started
  • Dependencies
  • Installing
  • Running the app
• Configuration
• AoT Don'ts
• External Stylesheets
• Contributing
• TypeScript
• @Types
• Frequently asked questions
• Support, Questions, or Feedback
• Deployment
• License

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:

angular-starter/ ├──config/                        * our configuration |   ├──build-utils.js             * common config and shared functions for prod and dev |   ├──config.common.json         * config for both environments prod and dev such title and description of index.html |   ├──config.dev.json            * config for development environment |   ├──config.prod.json           * config for production environment  │   │                              (note: you can load your own config file, just set the evn ANGULAR_CONF_FILE with the path of your own file) |   ├──helpers.js                 * helper functions for our configuration files |   ├──spec-bundle.js             * ignore this magic that sets up our Angular testing environment |   ├──karma.conf.js              * karma config for our unit tests |   ├──protractor.conf.js         * protractor config for our end-to-end tests │   ├──webpack.common.js          * common tasks for webpack build process shared for dev and prod │   ├──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 │   │ │   ├──app/                       * WebApp: folder │   │   ├──app.component.spec.ts  * a simple test of components in app.component.ts │   │   ├──app.e2e.ts             * a simple end-to-end test for / │   │   └──app.component.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 │ │ ├──tslint.json                    * typescript lint config ├──typedoc.json                   * typescript documentation generator ├──tsconfig.json                  * typescript config used outside webpack ├──tsconfig.webpack.json          * config that webpack uses for typescript ├──package.json                   * what npm uses to manage its dependencies └──webpack.config.js              * webpack main configuration file

What you need to run this app:

• node andnpm (brew install node)
• Ensure you're running the latest versions Nodev8.x.x+ (orv9.x.x) and NPM5.x.x+

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

Once you have those, you should install these globals withnpm 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)
• tslint (npm install --global tslint@4.5.1)

• 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 oryarn
• npm run server to start the dev server in another tab

After you have installed all dependencies you can now run the app. Runnpm run server to start a local server usingwebpack-dev-server which will watch, build (in-memory), and reload for you. The port will be displayed to you ashttp://0.0.0.0:3000 (or if you prefer IPv6, if you're usingexpress server, then it'shttp://[::1]:3000/).

# developmentnpm run server# productionnpm run build:prodnpm run server:prod

# developmentnpm run build:dev# production (jit)npm run build:prod# AoTnpm run build:aot

npm run server:dev:hmr

npm run watch

npm runtest

npm run watch:test

# update Webdriver (optional, done automatically by postinstall script)npm run webdriver:update# this will start a test server and launch Protractornpm run e2e

# this will test both your JIT and AoT buildsnpm run ci

npm run e2e:live

npm run build:docker

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

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 useform.controls.controlName, useform.get(‘controlName’)
• Don’t usecontrol.errors?.someError, usecontrol.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

For more detailed guide on AoT's Do's and Don'ts refer tohttps://github.com/rangle/angular-2-aot-sandbox

Any stylesheets (Sass or CSS) placed in thesrc/styles directory and imported into your project will automatically be compiled into an external.css and embedded in your production builds.

For example to use Bootstrap as an external stylesheet:

1. Create astyles.scss file (name doesn't matter) in thesrc/styles directory.
2. npm install the version of Bootstrap you want.
3. Instyles.scss add@import '~bootstrap/scss/bootstrap.scss';
4. Insrc/app/app.module.ts add underneath the other import statements:import '../styles/styles.scss';

You can include more examples as components but they must introduce a new concept such asHome 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 2.7.x includes everything you need. Make sure to upgrade, even if you installed TypeScript previously.

npm install --global typescript

We have good experience using these editors:

• Visual Studio Code
• Webstorm 2018.1
• Atom withTypeScript plugin
• Sublime Text withTypescript-Sublime-Plugin

InstallDebugger for Chrome and see docs for instructions to launch Chrome

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

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 intsconfig.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';

When including 3rd party modules you also need to include the type definition for the moduleif they don't provide one within the module. You can try to install it with @types

npm install @types/nodenpm install @types/lodash

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

declare module"my-module"{exportfunctiondoesSomething(value:string):string;}

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

declarevarassert:any;declarevar_:any;declarevar$:any;

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

import*as_from'lodash';

• What's the current browser support for Angular?
  • Please view the updated list ofbrowser support for Angular
• 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)
• Where do I write my tests?
  • You can write your tests next to your component files. See/src/app/home/home.component.spec.ts
• How do I start the app when I getEACCES andEADDRINUSE errors?
  • TheEADDRINUSE error means the port3000 is currently being used andEACCES is lack of permission for webpack to build files to./dist/
• How to usesass for css?
• • loaders: ['raw-loader','sass-loader'] and@Component({ styleUrls: ['./filename.scss'] }) see Wiki pageHow to include SCSS in components, or issue#136 for more information.
• How do I test a Service?
  • See issue#130
• How do I addvscode-chrome-debug support?
  • The VS Code chrome debug extension support can be done vialaunch.json see issue#144
• How do I make the repo work in a virtual machine?
  • You need to use0.0.0.0 so revert these changes#205
• What are the naming conventions for Angular?
  • please see issue#185 and PR196
• How do I include bootstrap or jQuery?
  • please see issue#215 and#214
• How do I async load a component?
  • see wikiHow-do-I-async-load-a-component-with-AsyncRoute
• Error: Cannot find module 'tapable'
  • Removenode_modules/ and runnpm cache clean thennpm install
• How do I turn on Hot Module Replacement
  • Runnpm run server:dev:hmr
• RangeError: Maximum call stack size exceeded
  • This is a problem with minifying Angular and it's recent JIT templates. If you setmangle tofalse 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.
• If you're in China
  • check outhttps://github.com/cnpm/cnpm
• node-pre-gyp ERR in npm install (Windows)
  • often happens when you're behind proxy and proxy wasn't configured in the npm as it tries to download binary package from the github and if it fails to do so, it will try to compile node-sass from the source codes
  • install Python3 x86
• 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}]
  • removenode_modules/typescript and runnpm install typescript@beta. This repo now uses ts 2.0
• "There are multiple modules with names that only differ in casing"
  • changec:\[path to angular-starter] toC:\[path to angular-starter] see926#issuecomment-245223547

Contact us anytime for anything about this repo or Angular

@PatrickJS__ on twitter

To run project you only need host machine withoperating system with installedgit (to clone this repo)anddocker and thats all - any other software is not needed(other software like node.js etc. will be automatically downloaded and installed inside docker container during build step based on dockerfile).

brew cask install docker

And run docker by Mac bottom menu> launchpad > docker (on first run docker will ask you about password)

sudo apt-get updatesudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609Dsudo apt-add-repository 'deb https://apt.dockerproject.org/repo ubuntu-xenial main'sudo apt-get updateapt-cache policy docker-enginesudo apt-get install -y docker-enginesudo systemctl status docker  # test: should be ‘active’

And add your user to docker group (to avoidsudo before usingdocker command in future):

sudo usermod -aG docker $(whoami)

and logout and login again.

Becausenode.js is big memory consumer you need 1-2GB RAM or virtual memory to build docker image(it was successfully tested on machine with 512MB RAM + 2GB virtual memory - building process take 7min)

Go to main project folder. To build image type:

docker build -t angular-starter .

Theangular-starter name used in above commands is only example image name.To remove intermediate images created by docker on build process, type:

docker rmi -f $(docker images -f "dangling=true" -q)

To run created docker image on localhost:8080 type (parameter-p 8080:80 is host:container port mapping)

docker run --name angular-starter -p 8080:80 angular-starter &

And that's all, you can open browser and go to localhost:8080.

To create and run docker image on localhost:8080 as part of large project you may usedocker-compose. Type

docker-compose up

And that's all, you can open browser and go to localhost:8080.

If you want to run image as virtual-host on sub-domain you must setupproxy. You should install proxy and set sub-domain in this way:

docker run -d -p 80:80 --name nginx-proxy -v /var/run/docker.sock:/tmp/docker.sock:ro jwilder/nginx-proxy:alpine

And in your/etc/hosts file (linux) add line:127.0.0.1 angular-starter.your-domain.com or in yor hosting addfollowing DNS record (wildchar* is handy because when you add new sub-domain in future, you don't need to touch/add any DNS record)

Type: CNAMEHostname: *.your-domain.comDirect to: your-domain.comTTL(sec): 43200

And now you are ready to run image on subdomain by:

docker run -e VIRTUAL_HOST=angular-starter.your-domain.com --name angular-starter angular-starter &

docker exec -t -i angular-starter /bin/bash

You can quickly create a free site to get started using thisstarter kit in production onNetlify:

Assuming you have SonarQube 5.5.6 (LTS) installed

• Setup SonarQube with theSonar Typescript plugin and the Generic Test Coverage pluginhttps://docs.sonarqube.org/display/PLUG/Generic+Test+Coverage
• Install sonar-scanner globally

npm install --global sonar-scanner

• Install theKarma plugin for sonarqube as a dev dependency

npm install karma-sonarqube-unit-reporter --save-dev

• Sonar Host URL configuration:Updatesonar-project.properties file for the propertysonar.host.url to point to your SonarQube server. By default this assumes that the SonarQube server is running locally using the default port

sonar.host.url=<Sonar Host URL and Port>

• Run the unit tests with sonar reporter enabled

npm run test:sonar

• The test results collected in the results folder in the sonar compatible format
• Push results to SonarCube

sonar-scanner

• If working with SonarQube 6.x it supportsGeneric Test Data
• Modify thekarma.conf.js to set the appropriate version of the sonarQube

sonarQubeUnitReporter:{sonarQubeVersion:'6.x',}

enjoy —PatrickJS

MIT