ecomp-portal-FE/README.md

   1 # readme file
   2 ## Initial installation
   3 #### Prerequisites
   4
   5 1. [node.js](https://nodejs.org/en/) - ssp project is running on node.js 4.1.1 please install from the link
   6 2. bower - install with npm: `npm install -g bower` _NOTE: mac/linux users should run the following command with `sudo`_
   7 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_
   8 4. grunt - install grunt with npm: `npm install -g grunt-cli` _NOTE: mac/linux users should run the following command with `sudo`_
   9
  10
  11 #### First run
  12 _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
  13
  14 1. run `npm install` to install all the server side dependencies
  15 2. run `bower install` to install all the client side dependencies
  16
  17 ## Running the project
  18
  19 this project it supported by grunt task manager, below are the different run options
  20 ssp project can be run with different client configurations per environment, the environment is set byt the option `--env=<environement name>`
  21 the following evironments are available:
  22
  23 mock - mock will activate the mock server and will return static data examples from predefined json files.
  24
  25 ### Dev time
  26
  27 1. to start the project in dev mode under mock please run: `grunt serve --env=mock`
  28 2. for any other client configuration change the `--env` option accordingly to env options available
  29
  30
  31 ### Tests
  32
  33 There are 3 options available for tests:
  34
  35 1. `grunt test` will run all re server and the client tests all together
  36 2. `grunt test:client` will run only the client tests
  37 3. `grunt test:server` will run only the server tests
  38
  39 ### Build time
  40
  41 Execute below commands
  42
  43 npm cache clean
  44 npm install
  45 npm install -g bower
  46 bower install
  47 grunt build --env=integ
  48
  49 COPY ${FE_DIR}/dist/public into ${BE_DIR}/public
  50
  51 deploy BE project onto tomcat and goto login page http://portal.openecomp.org:8989/ECOMPPORTAL/login.htm