ecomp-portal-FE/client/bower_components_external/angular.att.abs-2.17.0/README.md

   1 ![att_logo]
   2 # ABS Angular library
   3 A framework of [AngularJS] directives that allow for a plug'n'play development experience. This framework is apart of AT&T [QuickStart].
   4
   5 # Installation
   6
   7 The framework requres [NodeJS] to be installed prior to building.
   8
   9 ## Build
  10
  11 If on a Windows machine, you can quickly start the build by invoking Build.bat which in turn calls:
  12
  13     grunt --gruntfile ng-Gruntfile.js
  14     grunt --gruntfile Gruntfile.js
  15
  16
  17 If on Linux/Mac machine, you can directly execute the commands above.
  18
  19 ## Run the project
  20
  21 ### To Run in Netbeans
  22 1. Right Click on the project
  23 2. **Categories->Sources**
  24   * Set the value of "Site Root Folder" to "Production/dist"
  25 3. **Categories->Run**
  26   * Set the value of "Start File" to "ng-ui-elements.html"
  27   * Set the value of "Web Root" to "/"
  28
  29 ## How to contribute
  30
  31 ### To Add a New Module nModule
  32 1. Create a file Under the folder *ng-misc* nModule.hbs
  33   * nModule.hbs to be a copy of ng-misc/module.html
  34
  35 2. open nModule.hbs and replace all the occurance of *module* by *nModule*
  36
  37 3. ADD one entry at the end of the file app\templates\pages\ng-ui-elements.hbs
  38   * {{globWithContext 'app/templates/partials/ng-ui-elements/nModule.hbs' this}}
  39
  40 ### Create the following folder / file structure under the directory app\scripts\ng_js_att
  41 ```javascript
  42 app\scripts\ng_js_att\nModule\docs
  43 app\scripts\ng_js_att\nModule\test
  44 app\scripts\ng_js_att\nModule\nModule.js
  45 app\scripts\ng_js_att\nModule\docs\demo.html
  46 app\scripts\ng_js_att\nModule\docs\demo.js
  47 app\scripts\ng_js_att\nModule\docs\dev-notes.html
  48 app\scripts\ng_js_att\nModule\test\nModule.spec.js
  49 ```
  50
  51 ### Any templates used will go under the following folder app\scripts\ng_js_att_tpls
  52 General Development Rules:
  53
  54 1. Directive to have only the logic.
  55
  56 2. Styles to be out of the logic.
  57
  58 3. Markup to be into templates.
  59
  60 # Copyright
  61 PROPRIETARY INFORMATION
  62
  63 _Not for use or disclosure outside of the AT&T family of companies, except under written agreement._
  64
  65
  66 [AngularJS]:http://angularjs.org
  67 [QuickStart]:http://quickstart.att.com
  68 [NodeJS]:http://nodejs.org
  69 [att_logo]:http://www.underconsideration.com/speakup/archives/att_new_logo.jpg
  70 [det_logo]: http://quickstart.web.att.com/images/logo-DETS.png