Sample Deployable Web UI View

Note: readme.md best viewed with a markdown preview app such as Chrome's Markdown Preview extension or the idea-markdown plugin for IntelliJ.

Building

Build war file: mvn clean install

Performs the following actions:

1. Downloads all node modules required for building the web app.
2. Downloads the javascript libraries used by the web management console (including the Spectrum web sdk).
3. Performs a build using grunt.
4. Packages the results in a war file in the target directory.
5. If the maven development profile is active, the newly created war file is automatically copied to the deployment folder of the development Spectrum distribution:      cdqp/trunk/development/platform/server/container/dist/target/spectrum-server-distribution/server/app/deploy/

Build web app: grunt or grunt build:prod

The production build script utilized by mvn clean install. It assumes all artifacts/dependencies have been downloaded.
This will run a build that includes all the goodies (linting, minification, testing, etc.). All artifacts will be placed in the dist directory. It does not create the war file (use maven for this).

Developing

Development build: grunt build:dev

Runs a build that excludes minification. This allows debugging of non-minified code.

All artifacts will be placed in the dist directory and also copied to the "live" deployment location within the development Spectrum distribution:      cdqp/trunk/development/platform/server/container/dist/target/spectrum-server-distribution/server/app/tmp/web/iedeployableview.war/webapp This allows for the contents to be hot-deployed to a running Spectrum server.

In addition, a watch task will continue to run in the background. Whenever any changes to a source file (js, html, css, json translations) are detected, the associated file will be auto-deployed to the running Spectrum server. Simply refresh an existing browser connection to load/view the changes.

Testing

Run Karma: grunt test

This will fire up the Karma unit test runner and open a new Chrome window. Karma automatically detects changes to JavaScript files and executes all unit tests found in the project. The results of the tests will be outputted in the command window.

To debug unit tests, click the Debug button in the browser window to debug directly in Chrome. To use IntelliJ to debug, create a JavaScript Debug configuration and point it to http://localhost:9876. Alternatively, install the IntelliJ Karma plugin to run/debug Karma directly from IntelliJ.