diff --git a/web/README_WGU.org b/web/README_WGU.org index 029bbae..1555a70 100644 --- a/web/README_WGU.org +++ b/web/README_WGU.org @@ -17,6 +17,8 @@ After I describe the steps to initialize a development environment, you'll find * Evaluation Technical Documentation +It's probably not necessary for you to replicate my development environment in order to evaluate this project. You can access the deployed application at https://darklimericks.com/wgu and the libraries and supporting code that I wrote for this project at https://github.com/eihli/clj-tightly-packed-trie, https://github.com/eihli/syllabify, and https://github.com/eihli/prhyme. The web server and web application is not hosted publicly but you will find it uploaded with my submission as a ~.tar~ archive. + ** How To Initialize Development Environment *** Required Software @@ -24,6 +26,14 @@ After I describe the steps to initialize a development environment, you'll find - [[https://www.docker.com/][Docker]] - [[https://clojure.org/releases/downloads][Clojure Version 1.10+]] - [[https://nodejs.org/en/download/][NodeJS]] +- [[https://github.com/clojure-emacs/cider][Emacs and CIDER]] + +*** Steps + +1. Run ~./db/run.sh && ./kv/run.sh~ to start the docker containers for the database and key-value store. + a. The ~run.sh~ scripts only need to run once. They initialize development data containers. Subsequent development can continue with ~docker start db && docker start kv~. +2. Start a Clojure REPL in Emacs, evaluate the ~dev/user.clj~ namespace, and run ~(init)~ +3. Run ~npx shadow-cljs watch :frontend~ in the ~web/wgu-app~ directory to build the web interface. ** How To Run Software Locally