LP#1626157 docs
authorBill Erickson <berickxx@gmail.com>
Tue, 15 May 2018 14:27:59 +0000 (10:27 -0400)
committerBill Erickson <berickxx@gmail.com>
Tue, 15 May 2018 14:28:12 +0000 (10:28 -0400)
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Open-ILS/src/eg2/README.adoc

index 2e4f209..2f89011 100644 (file)
@@ -1,5 +1,7 @@
 = EG Angular2 App =
 
+== Initial Setup
+
 === Apache Configuration ===
 
 [source,conf]
 </Directory>
 ---------------------------------------------------------------------
 
+[source,sh]
+---------------------------------------------------------------------
+sudo systemctl reload apache2
+---------------------------------------------------------------------
+
+=== Dependencies
+
+* Current angular/cli version is 6.x which requires Node8.  Will 
+  resolve as part of the Angular6 update.
+
+[source,sh]
+---------------------------------------------------------------------
+$ sudo npm install -g @angular/cli@1.7.3
+$ cd $EVERGREEN/Open-ILS/src/eg2
+$ npm update
+---------------------------------------------------------------------
+
 === Transpile + Deploy in --watch mode for Dev ===
 
+* Development builds
+** Using the JIT compiler which is faster to compile, but slower 
+   in the browser.
+
 [source,sh]
 ---------------------------------------------------------------------
-ng build --aot --app eg --deploy-url /eg2/ --base-href /eg2/ --output-path  ../../web/eg2/  --watch
+$ cd $EVERGREEN/Open-ILS/src/eg2
+$ npm update
+$ ng build --app eg --watch --deploy-url /eg2/ --base-href /eg2/ --output-path  ../../web/eg2/
+---------------------------------------------------------------------
+
+* Production builds
+** Using AOT compiler, which is slower to compile, but faster in the browser.
+
+[source,sh]
+---------------------------------------------------------------------
+ng build --app eg --aot --prod --deploy-url /eg2/ --base-href /eg2/ --output-path  ../../web/eg2/
 ---------------------------------------------------------------------
 
 === Link build files into place for ease of dev
 
+* Optionally copy the files into place via 'make install' (or 'cp')
+
 [source,sh]
 ---------------------------------------------------------------------
-sudo -u opensrf ln -s /PATH/TO/Evergreen/Open-ILS/web/eg2 /openils/var/web/eg2
+sudo -u opensrf ln -s $EVERGREEN/Open-ILS/web/eg2 /openils/var/web/eg2
 ---------------------------------------------------------------------