web staff / log : install and hacking

Signed-off-by: Bill Erickson <berick@esilibrary.com>

diff --git a/web-staff-log.txt b/web-staff-log.txt
index dc8fb49..2e61630 100644 (file)
--- a/web-staff-log.txt
+++ b/web-staff-log.txt
@@ -248,6 +248,89 @@ for both scopes.
 For more, see 
 https://github.com/angular/angular.js/wiki/Understanding-Scopes[Understanding-Scopes].
 
+2013-11-25 Prototype Install and Hacking
+----------------------------------------
+
+Installing the code
+~~~~~~~~~~~~~~~~~~~
+
+The code lives at http://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/collab/berick/web-staff-proto[working => collab/berick/web-staff-proto]
+
+****
+The branch is a child of Evergreen master and will be kept up to date
+with master as development progresses.  
+****
+
+Install the code in the usual Evergreen manner -- No DB upgrades are
+required to date, but there are some IDL changes -- and apply the Apache
+configuration changes found in eg_vhost.conf:
+
+[source,conf]
+-----------------------------------------------------------------------------
+# see notes above on how we can condense the configuration...
+# TODO: some of this is clearly redundant and needs to be rearranged
+<Location /eg/staff/>
+    Options -MultiViews
+    RewriteEngine On
+    RewriteCond %{PATH_INFO} !/staff/index
+    RewriteCond %{PATH_INFO} !/staff/t_*
+    RewriteRule .* /eg/staff/index [L,DPI]
+    <IfModule mod_headers.c>
+        Header append Cache-Control "public"
+    </IFModule>
+    <IfModule mod_deflate.c>
+        SetOutputFilter DEFLATE
+        BrowserMatch ^Mozilla/4 gzip-only-text/html
+        BrowserMatch ^Mozilla/4\.0[678] no-gzip
+        BrowserMatch \bMSI[E] !no-gzip !gzip-only-text/html
+        SetEnvIfNoCase Request_URI \.(?:gif|jpe?g|png)$ no-gzip dont-vary
+        <IfModule mod_headers.c>
+            Header append Vary User-Agent env=!dont-vary
+        </IfModule>
+    </IfModule>
+</Location>
+<Location /eg/staff/cat/bucket/record/>
+    Options -MultiViews
+    RewriteEngine On
+    RewriteCond %{PATH_INFO} !/staff/cat/bucket/record/index
+    RewriteCond %{PATH_INFO} !/staff/cat/bucket/record/t_*
+    RewriteRule .* /eg/staff/cat/bucket/record/index [L,DPI]
+</Location>
+<Location /eg/staff/circ/patron/>
+    Options -MultiViews
+    RewriteEngine On
+    RewriteCond %{PATH_INFO} !/staff/circ/patron/index
+    RewriteCond %{PATH_INFO} !/staff/circ/patron/t_*
+    RewriteRule .* /eg/staff/circ/patron/index [L,DPI]
+</Location>
+<Location /js/>
+    <IfModule mod_headers.c>
+        Header append Cache-Control "public"
+    </IFModule>
+    <IfModule mod_deflate.c>
+        SetOutputFilter DEFLATE
+        BrowserMatch ^Mozilla/4 gzip-only-text/html
+        BrowserMatch ^Mozilla/4\.0[678] no-gzip
+        BrowserMatch \bMSI[E] !no-gzip !gzip-only-text/html
+        SetEnvIfNoCase Request_URI \.(?:gif|jpe?g|png)$ no-gzip dont-vary
+        <IfModule mod_headers.c>
+            Header append Vary User-Agent env=!dont-vary
+        </IfModule>
+    </IfModule>
+</Location>
+-----------------------------------------------------------------------------
+
+Once installed, point Chrome or Firefox at https://hostname/eg/staff/ to see
+the splash page.
+
+Hacking
+~~~~~~~
+
+Most of the code should seem familiar.  The Template Toolkit templates 
+behave as usual.  For modifying scripts and Angular-loaded templates, I 
+highly recommend Chrome's "Disable Cache (while dev tools is open)" option
+found under the Javascript console (dev tools) configuration menu (gear
+icon, bottom right) since Chrome aggressively caches the templates.
 
 Future Topics...
 ----------------
@@ -258,3 +341,7 @@ Future Topics...
  * When to use Angular Templates vs Template Toolkit Templates
  * Displaying bib records in the prototype
 
+
+////
+vim: ft=asciidoc
+////