ecomp-portal-FE-os/README.md

   1 # ECOMP Portal Web Application Front End for Open-Source Use
   2
   3 ## Overview
   4
   5 This is a Maven project with the ECOMP Portal front-end files for public
   6 release, containing font files, image files and other static files.
   7 This project uses Maven to copy in ("overlay") the contents of the ECOMP
   8 Portal FE common files at package time.
   9
  10 Use Apache Maven to build and package this collection of files using Bower,
  11 Grunt and NPM.
  12
  13 ## Release Notes
  14
  15 Release notes for all ECOMP Portal *Open Source specific* files, including
  16 front-end files, are tracked in file ecomp-portal-BE-os/README.md
  17
  18 ## Installation Notes
  19
  20 TODO: These notes are somewhat outdated.
  21
  22 ### Prerequisites
  23
  24 1. [node.js](https://nodejs.org/en/) - ssp project is running on node.js 4.1.1 please install from the link
  25 2. bower - install with npm: `npm install -g bower` _NOTE: mac/linux users should run the following command with `sudo`_
  26 3. [git](https://git-scm.com/) - install git command line tool _NOTE: please select to add git command line into the PATH variable for it to be accessible from any folder_
  27 4. grunt - install grunt with npm: `npm install -g grunt-cli` _NOTE: mac/linux users should run the following command with `sudo`_
  28
  29
  30 ### First run
  31 _NOTE: some npm modules inside the project does not support yet the new node.js 4.1.1, npm install command will probably throw an error. even so, everything should work, so no need to worry
  32
  33 1. run `npm install` to install all the server side dependencies
  34 2. run `bower install` to install all the client side dependencies
  35
  36 ### Running the project
  37
  38 this project it supported by grunt task manager, below are the different run options
  39 ssp project can be run with different client configurations per environment, the environment is set byt the option `--env=<environement name>`
  40 the following evironments are available:
  41
  42 mock - mock will activate the mock server and will return static data examples from predefined json files.
  43
  44 ### Dev time
  45
  46 1. to start the project in dev mode under mock please run: `grunt serve --env=mock`
  47 2. for any other client configuration change the `--env` option accordingly to env options available
  48
  49
  50 ### Tests
  51
  52 There are 3 options available for tests:
  53
  54 1. `grunt test` will run all re server and the client tests all together
  55 2. `grunt test:client` will run only the client tests
  56 3. `grunt test:server` will run only the server tests
  57
  58 ### Build time
  59
  60 Execute below commands
  61
  62 npm cache clean
  63 npm install
  64 npm install -g bower
  65 bower install
  66 grunt build --env=integ
  67
  68 COPY ${FE_DIR}/dist/public into ${BE_DIR}/public
  69
  70 deploy BE project onto tomcat and goto login page http://portal.openecomp.org:8989/ECOMPPORTAL/login.htm