Searchable Document Archive

Lukas Romsicki (101059080)
Britta Evans-Fenton (101017131)

Prerequisites

Java 13
MongoDB 4.2.2

Preliminary

The database, graph, and Lucene index must be loaded with data first for the app to function correctly.

Start a MongoDB server at localhost with port 27017.
Open the project in Eclipse.
Right-click on the project root, then click Gradle > Refresh Gradle Project. You must have a working internet connection for this to work.
- This step will download all the necessary dependencies to your machine.
Go to Project > Clean to clean the project of any possible artifacts.

Performing a crawl

Right-click on CrawlerController.java in the Project Explorer, then click Run as > Java Application.
Wait until the crawl completes. A completion message will be printed to the Eclipse console.

Starting the server

You can either: a) Deploy the war file, or; b) Launch the server through Eclipse.

Through Eclipse:

Assuming you still have the Eclipse project open as per the Preliminary section.

Open a server resource file, for example, MainResource.java.
Click the green "play" button in the Eclipse toolbar.
Wait for the server to launch.

Starting the client

Note: You must have a Mac with the latest version of Xcode for this to work.

Open the Xcode project from SDAClient.
Select a target (either Simulator or physical device).
Click the "Run" button in the toolbar.

You can then use the search bar to search. A debounce of 2 seconds has been implemented. That is, the client waits 2 seconds after the user has finished typing before submitting the request to the server, allowing for the UI to not be locked.

If you are running on a physical device, you may want to change the address of the server. To do this:

Click the "gear" icon at the top.
Enter the host (and port) of the server in the presented sheet.
Close the sheet by swiping down and perform a search as per normal.

Extra implementations

Dark mode is supported.

lfroms / COMP4601-SDA