ITM Web Client


Note on package structure

Where possible package dependencies are stored at top level node_modules and shared down to packages to help speed up install time. Note npm auto traverses up to the parents to find imports.

Setup

1. Clone the project from Git repo
2. Make sure you have node installed (install Node.js LTS v4.X.X, NPM 2.X)

To be updated

Run dev mode:

Dev mode enables Webpack hot loading with Redux dev tools - code changes are saved and pushed directly to the browser. TBD

Unit tests

TBD

E2E testing

Tests live at /tests/e2e within appropriate packages Protractor is included for E2E testing, loads selenium web driver and allows for JS based automation tests using familiar Jasmine BDD test syntax.

1. Ensure the webserver is running
2. Configure properties as appropriate at tests/e2e/protractor.json (to set browser type etc)
3. Execute Protractor tests from package top level e.g packages/itm-web npm run e2e
4. Screenshots are posted to tests/out/e2e including screenshots and compiled report.html

To be updated

Static Analysis (Eslint)

All projects are covered with eslint rules to common standard (based on airbnb) https://github.ibm.com/ess/javascript-guide It is advised to run eslinter in your IDE as you develop - as all code will be linted on the CI pipeline

To be updated

Production build and run

TBD

Deployment

See deployment folder for details on Docker container packaging of the application.

Research Server ess-coreui/poc/AggregationComponent

Search Aggregation Application which provides a new Smarter rollup of ActivityStream items. Introducing a stacked relationship between items based on followed entities Maintained by Search team in Haifa.

Misc

What does the CI pipeline run

Generally as follows

• npm run install (install top level dependencies shared throughout)
• npm run link-packages (link projects and install sub dependencies)
• npm run test (run the npm run test script in all packages)
• npm run lint (run the npm run lint script in all packages)
• Production build and run
• E2E target on itm-web
• Production stop server

See Jenkins Server [https://connjenk.swg.usma.ibm.com/jenkins/view/CNext/job/itm-web-client/]

To be updated

Known issues.