diff --git a/README.md b/README.md index a1099b4ad222bf8699045796f5e13e6e331dfd3d..1400143c0029bc82d3bed692bfb7b60301df6f05 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,16 @@ The UNLedu Framework is expected to regularly request the JavaScript file `www/j Automated Testing ----- -Run automated tests via this command `pyrus run-phpt tests` \ No newline at end of file +Run automated tests via this command `pyrus run-phpt tests` + +Local Installation +------ +1) Clone and configure configure virtual host for [WDN Repo](https://github.com/unl/wdntemplates) +2) Clone [UNL Alert](https://git.unl.edu/dxg/UNL_Alert) and configure virtual host to point to `UNL_Alert/www` +3) Update `www/json/unlcap.js` to use a test alert data. For example: + unlAlerts.data = {"alert":{"identifier":"cd32fb091ecd347f4d49f7b53b073b9d","sender":"police.unl.edu","sent":"2024-06-10T19:17:39+00:00","status":"Test","msgType":"Alert","scope":"Public","note":"This is only a test2","info":[{"category":"Safety","event":"UNL Alert","ugency":"Immediate","severity":"Extreme","certainty":"Observed","headline":"Mark Only Test","description":"UNL Alert: this is a test3","web":"http:\/\/www.unl.edu\/"}]}}; +4) Update alertDataURL in `wdn/templates_5.3/js-src/unlalert.babel.js` to point to your localhost alert's unlcap.js file (e.g https://localhost.unl.edu/json/unlcap.js) +5) Use test SHTML files like `debug-clean.shtml` in the WDN project you have cloned to verify that the alert banner is working +6) If the banner is not displaying, try disabling your browser's cache. + +last updated July 17, 2024 \ No newline at end of file