From 57279445de5bf4af081313572d57c8436cb1c4cb Mon Sep 17 00:00:00 2001 From: Viliam Rockai Date: Tue, 3 Feb 2015 13:03:55 +0100 Subject: [PATCH] Readme for console maven build update --- ui/README.adoc | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/ui/README.adoc b/ui/README.adoc index 6c24f93d..0f9dd195 100644 --- a/ui/README.adoc +++ b/ui/README.adoc @@ -12,16 +12,49 @@ This console application pulls in various bower packages (libs) and Hawt.io 2 pl The general idea here being hawt.io UIs which are composed of plugins (that can swapped around like legos between the various UIs) +== Maven Install + +The easiest way to build the console is to use maven (inside the `console` directory): + +`mvn install` + +No system http://nodejs.org/[Node.js] dependencies are needed. +http://nodejs.org/[Node.js] and its related modules are managed by the https://github.com/eirslett/frontend-maven-plugin[frontend-maven-plugin]. +They are downloaded to the build target (./console/target) directory, where the actual http://gulpjs.com/[Gulp] based build process +(triggered by the maven plugin) happens. + +To save some time during the build process, the downloaded http://nodejs.org/[Node.js] files and its related modules are not deleted after the + +`mvn clean` + +is executed. If you want to delete the whole target directory, please use the `release` profile: + +`mvn clean -Prelease` + +In that case, the http://nodejs.org/[Node.js] is downloaded again, together with relevant modules. + +After the console is built, you can access it by traversing to the the build target (./console/target) directory: + +`cd console/target` + +and running the appropriate gulp (default) target: + +`gulp` + +After those steps, the console is available on http://localhost:2772/[http://localhost:2772/] == Dev Install +You can still re-build the console using only java-script based tools. Please do that only after maven build and +only within the build target (./console/target) directory. + Assuming the node.js is already installed: `npm install -g bower gulp typescript` Install the cli commands globally -`cd ui/console` +`cd console/target` `npm install`