0.2.0 • Published 7 years ago

plm-angular-app v0.2.0

Weekly downloads
2
License
Apache-2.0
Repository
github
Last release
7 years ago

PLM-angular-app

Prerequisites

Before you start using this development framework, make sure you have installed all required software and done all the necessary configuration, see this page.

Install

Follow the 3 steps below:

  1. Npm

    npm install PLM-angular-app --save
  2. Html

    Include these dependencies in your index.html page:

    <!-- Google Material Design Lite -->
    <link rel="stylesheet" href="node_modules/material-design-lite/material.min.css">
    <script src="node_modules/material-design-lite/material.min.js"></script>
    <link rel="stylesheet" href="node_modules/material-design-icons/iconfont/material-icons.css">
    
    <!-- Polyfill(s) for Safari (pre-10.x) -->
    <script src="node_modules/intl/dist/Intl.min.js"></script>
    <script src="node_modules/intl/locale-data/jsonp/en.js"></script>
    
    <!-- Polyfill(s) for older browsers -->
    <script src="node_modules/core-js/client/shim.min.js"></script>
    <script src="//cdnjs.cloudflare.com/ajax/libs/dom4/1.8.3/dom4.js"></script>
    <script src="node_modules/element.scrollintoviewifneeded-polyfill/index.js"></script>
    
    <!-- Polyfill(s) for dialogs -->
    <script src="node_modules/dialog-polyfill/dialog-polyfill.js"></script>
    <link rel="stylesheet" type="text/css" href="node_modules/dialog-polyfill/dialog-polyfill.css" />
    <style>._dialog_overlay { position: static !important; } </style>
    
    <!-- Modules  -->
    <script src="node_modules/zone.js/dist/zone.js"></script>
    <script src="node_modules/reflect-metadata/Reflect.js"></script>
    <script src="node_modules/systemjs/dist/system.src.js"></script>
  3. SystemJs

    Add the following components to your systemjs.config.js file:

    • ng2-translate
    • alfresco-js-api
    • ng2-alfresco-core
    • PLM-angular-app

    Please refer to the following example file: systemjs.config.js(demo/systemjs .config.js) .

PLM Tool

Basic usage

<PLM-angular-app></PLM-angular-app>

Usage example of this component :

main.ts

Events

MethodParametersReturnsDescription
methodName()None.voidLorem ipsum dolor.

Options

AttributeOptionsDefaultDescription
foostringbarLorem ipsum dolor.

Build from sources

Alternatively you can build component from sources with the following commands:

npm install
npm run build

Build the files and keep watching for changes

$ npm run build:w

Running unit tests

npm test

Running unit tests in browser

npm test-browser

This task rebuilds all the code, runs tslint, license checks and other quality check tools before performing unit testing.

Code coverage

npm run coverage

Demo

If you want have a demo of how the component works, please check the demo folder :

cd demo
npm install
npm start

NPM scripts

CommandDescription
npm run buildBuild component
npm run build:wBuild component and keep watching the changes
npm run testRun unit tests in the console
npm run test-browserRun unit tests in the browser
npm run coverageRun unit tests and display code coverage report
npm run build.umdBuild the UMD bundle package

History

For detailed changelog, check Releases.

Contributors

Contributors