Installing

This section describes the steps required to install and maintain ReCiter.

• Supported environments and technical requirements
• Installing on a server
• Installing the database
• Starting the database
• Connecting to the database
• Running for a target author
• Querying the database
• Configuring the application.properties file
• Sample data flow

Installing on a server

Installation prerequisites

To install ReCiter as a server you will first need to install Java, Git, and Apache Maven, as described here. These tools are freely available.

Install ReCiter as a server without Eclipse

• Open a terminal window or command prompt as follows:

If you are using a Mac (OS X, click the magnifying glass in your menu bar to open Spotlight.

Enter "Terminal" in the search box and double-click the application.

You can also use Finder to navigate to your Applications folder, open the Utilities folder, and then open the Terminal application.

If you are using Windows, instructions for opening a command prompt for Windows 7, 8, and 10 are available here.

• Use the change directory command cd to navigate to the directory where you would like to install ReCiter. For example: cd /Users/myaccount/reciter

• Enter the following command to use git to clone ReCiter to your local machine: git clone https://github.com/wcmc-its/ReCiter.git

• Enter the following command to star ReCiter by using the Spring Boot framework: mvn spring-boot:run

Install ReCiter as a server with Eclipse

Download the latest version of Eclipse

• Install Eclipse using the install method appropriate for your operating system
• Run Eclipse
• From the File menu, select Import
• Click the triangle next to Git, then select Projects from Git and click the Next button.

• From the Eclipse welcome screen, click on "Checkout projects from Git". (If you do not see the Eclipse welcome screen it may be accessed by selecting "Help", then "Welcome".)
• Click "Clone URI"

• Click Next
• In the "URI" box, type https://github.com/wcmc-its/ReCiter.git

• In the Authentication panel, enter your login username and password for the GitHub repository and click the Finish button
• Once the ReCiter project has finished compiling, right-click on the parent directory for the ReCiter project in the Package Explorer in Eclipse and select "Team, Pull"

• In the Package Explorer, right-click on src/main/java/reciter/Application.java and select "Run As, Java Application"

• After running ReCiter, you can look at the results by querying the database.

Run ReCiter on the server

After installing ReCiter with either of the two methods above (i.e., with or without Eclipse), you can use the RESTful API to operate ReCiter.

Prior to running ReCiter, you must first install the database, populate it with identity data for the target author(s), and connect to the database.

• To use API calls to run ReCiter, open your web browser, where you may operate ReCiter by using API commands. For example, if the ReCiter server is on your local machine, to run ReCiter for all UIDs, enter the following: localhost:8080/reciter/all/analysis/

If ReCiter runs successfully, you should see the "Success" message appear in your browser window.