CloudRead is a REST client for the article authoring tool, CloudWrite. It provides read-only, frontend access to the CloudWrite database, and primarily consumes XML, saving properties to an XML file. Handling JSON is also provided though all subsequent Java object instantiation is based on the XML file.

CloudRead can retrieve saved queries by ID for the user to view without re-querying CloudWrite. Each article can be exported as a DOCX file. With each export, the DOCX file is saved here.

Download copies of the JAR directories and subdirectories present for both CloudRead and CloudWrite. Run both JARs in separate terminals as outlined in their respective READMEs. Then access localhost port 5000 for CloudWrite or localhost port 8080 for CloudRead.

The Docker Hub image is here.

To build a CloudRead Docker image, follow the guidelines here. This also contains instructions about running both CloudWrite (to build a CloudWrite image, go here and CloudRead containers in their own subnet with Docker Compose.

As will become apparent on inspection, CloudRead uses the same XML schema XSD as CloudWrite and generates DTO classes during packaging. To extend CloudRead, one is advised to first build the project so that the IDE can recognise the generated classes (typically located in /target) before continuing.