README

Table of contents

1. Prerequisites
2. Installation
3. Scripts
4. Contribute - Git
5. Configuration
6. Documentation
7. Styling

Prerequisites

These modules must be globally installed:

• eslint: Code analysis for JavaScript & AngularJS.
• htmlhint: Code analysis for HTML.
• sass-lint: Code analysis for Sass.

Installation

$ npm install               # Development
$ npm install --production  # Production (only `dependencies`)

Scripts

• npm start to launch npm run server and json-server (if checked) in parallel
• npm run serve to launch a webpack-dev-server server on your source files
• npm run serve:prod to launch a webpack-dev-server server on your source files in a production environment
• npm run build to build an optimized version of your application in /dist
• npm run build:prod to build an optimized version of your application in /dist in a production environment
• npm run test to launch your unit tests with Karma
• npm run lint to launch linting process

Contribute - Git

See commits convention.

Configuration

See configuration documentation.

Documentation

Angular documentation is generated with DGeni

Docs generation is performed by webpack-angular-dgeni-plugin

Please refer to Angular documentation for documentation comments.

Configuration

It's possible to include or exclude other glob link (default: src/app/**/*) in file webpack.config.js in build target.

For more details about configuration, please refer to the plugin documentation.

Launch

Documentation is launched by adding --docs argument to webpack. Which is already done by default for build and build:prod NPM scripts.

Static documentation

Static documentation is written in markdown format under docs folder.

Styling

See styling guidelines.