Skip to content

developers-guide.md

Latest commit

 

History

History
64 lines (46 loc) · 3.05 KB

developers-guide.md

File metadata and controls

64 lines (46 loc) · 3.05 KB

This project was generated with Angular CLI version 1.6.8.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|module.

To get more help on the Angular CLI use ng help or go check out the Angular CLI README.

To enable Yarn for Angular CLI, run the following command inside root directory: ng set packageManager=yarn

Running unit tests

Run yarn test to execute the unit tests via Karma.

Running end-to-end tests

Run yarn e2e to execute the end-to-end tests via Protractor.

Before running the tests make sure app is able to communicate with the FogLAMP REST Server API. Put the REST API info in e2e/environment.ts.

REST API URL Configuration:

Dev Mode:

Set default API base URL in environments/environment.ts, you can always change it and restart the app from settings.

Production Mode:

Set API base URL in environments/environment.prod.ts, you can always change it and restart the app from settings.

Used Libraries:

Core:

Library Version Latest Stable (? Y/n) License
Angular 5.2.11 6.0.0 MIT
Angular CLI 1.7.4 6.0.1 MIT
TypeScript 2.6.2 2.8.3 Apache 2.0
rxjs 5.5.10 6.1.0 Apache 2.0
Bulma css 0.7.1 0.7.1 MIT

Dev:

Library Version Latest Stable (? Y/n) License
chart.js 2.7.2 2.7.2 MIT
core-js 2.5.6 2.5.6 MIT
lodash-es 4.17.10 4.17.10 MIT
ng-sidebar 6.0.4 7.1.0 MIT
moment 2.22.1 2.22.1 MIT
ngx-progressbar 2.1.1 2.1.1 MIT
angular2-multiselect-dropdown 2.7.0 2.9.0 MIT

Why Yarn?

  • Yarn parallelizes operations to maximize resource utilization so install times are faster than ever.
  • Offline cache: package installation using Yarn, it places the package on your disk. During the next install, this package will be used instead of sending an HTTP request to get the tarball from the registry.
  • Deterministic Installs: Yarn uses lockfiles (yarn.lock) and a deterministic install algorithm. We can say goodbye to the "but it works on my machine" bugs.

Yarn commands

  • yarn # Install all dependencies from package.json
  • yarn install # Alias for yarn
  • yarn add [package] # Install npm package
  • yarn upgrade [package] # Upgrade npm package
  • yarn remove [package] # Uninstall npm package

To read more about yarn read https://yarnpkg.com/en/