LP#1775466 Doc updates
authorBill Erickson <berickxx@gmail.com>
Tue, 15 May 2018 17:09:17 +0000 (13:09 -0400)
committerBill Erickson <berickxx@gmail.com>
Wed, 6 Jun 2018 20:59:33 +0000 (16:59 -0400)
Signed-off-by: Bill Erickson <berickxx@gmail.com>
Open-ILS/src/eg2/README.adoc

index 263fff9..5874e69 100644 (file)
@@ -1,9 +1,18 @@
-= EG Angular2 App =
+= Evergreen Angular6 App =
+
+NOTE: Angular v6 requires NodeJS v8.  Node v8 appears to be working fine
+with the AngularJS client, but for now, you may wish to build this code
+on a separate VM to avoid disruption.
+
+When installing on an exising machine, remove the 'node_modules' directory
+ and run 'npm update ; npm install' before building the AngularJS client.
 
 == Initial Setup
 
 === Apache Configuration ===
 
+* Add the following to /etc/apache2/eg_vhost.conf
+
 [source,conf]
 ---------------------------------------------------------------------
 <Directory "/openils/var/web/eg2">
 </Directory>
 ---------------------------------------------------------------------
 
+* And reload the configuration.
+
 [source,sh]
 ---------------------------------------------------------------------
 sudo systemctl reload apache2
 ---------------------------------------------------------------------
 
-=== Dependencies
+=== Install Dependencies
 
 [source,sh]
 ---------------------------------------------------------------------
@@ -30,19 +41,18 @@ $ npm update
 $ npm install
 ---------------------------------------------------------------------
 
-=== Transpile + Deploy in --watch mode for Dev
+=== Compile and Deploy -- Dev Mode
 
-* Development builds
-** Using the JIT compiler which is faster to compile, but slower 
-   in the browser.
+* Uses the JIT compiler which is faster to compile, but slower in the browser.
 
 [source,sh]
 ---------------------------------------------------------------------
 $ ng build --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.
+=== Compile and Deploy -- Prod Mode
+
+* Uses the AOT compiler, which is slower to compile, but faster in the browser.
 
 [source,sh]
 ---------------------------------------------------------------------
@@ -58,3 +68,8 @@ $ ng build --aot --prod --deploy-url /eg2/ --base-href /eg2/ --output-path  ../.
 $ sudo -u opensrf ln -s $EVERGREEN/Open-ILS/web/eg2 /openils/var/web/eg2
 ---------------------------------------------------------------------
 
+== Access The Interface
+
+Navigate to https://HOSTNAME/eg2/staff/login
+
+