These modules must be globally installed:
eslint
: Code analysis for JavaScript & AngularJS.htmlhint
: Code analysis for HTML.sass-lint
: Code analysis for Sass.
$ npm install # Development
$ npm install --production # Production (only `dependencies`)
npm start
to launchnpm run server
andjson-server
(if checked) in parallelnpm run serve
to launch a webpack-dev-server server on your source filesnpm run serve:prod
to launch a webpack-dev-server server on your source files in a production environmentnpm run build
to build an optimized version of your application in /distnpm run build:prod
to build an optimized version of your application in /dist in a production environmentnpm run test
to launch your unit tests with Karmanpm run lint
to launch linting process
See commits convention.
See configuration documentation.
Angular documentation is generated with DGeni
Docs generation is performed by webpack-angular-dgeni-plugin
Please refer to Angular documentation for documentation comments.
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.
Documentation is launched by adding --docs
argument to webpack. Which is already done by default for build
and build:prod
NPM scripts.
Static documentation is written in markdown format under docs
folder.
See styling guidelines.