Brainstorm

• GenderOptions.txt file path
• Dietary restrictions
• How locations are stored (persist for the program only)
• Instructions on how to run javadoc
• You don't have to include postresql and junit and hamcrest but tell them how to get it
• keeps tests and main separate but instruct on how to run tests and run main
• press ctrl + c to force quit
• where the sql file is stored. how to setup the database.

User Manual

Welcome to the User Manual for the OOP Project! This manual will guide you through the process of setting up and running the program.

About the Program

TODO: Complete this

Setting Up the Program

To set up the program, you will need to have the following installed on your computer:

• Java 11

For installation of Java, follow the instructions on the Java website.

You will also need to have the following .jar files in the project directory:

• postgresql-42.7.2.jar
• junit-4.13.2.jar
• hamcrest-core-1.3.jar

These files can be downloaded from the following links:

• PostgreSQL JDBC Driver
• JUnit
• Hamcrest

The file structure for this project (Maven) ensures that the main program and the tests are kept separate. The main program is located in the src/main/java/edu/ucalgary/oop directory, while the tests are located in the src/test/java/edu/ucalgary/oop directory.

Ensure you have the GenderOptions.txt file in the project directory. It should be in the src/main/resources directory.

This program interfaces with the PostgreSQL database, so you will need to have PostgreSQL installed on your computer. You can download PostgreSQL from the PostgreSQL website. After downloading and installing PostgreSQL, open the PostgreSQL Shell, login with:

Server [localhost]:
Database [postgres]:
Port [5432]:
Username [postgres]:
Password for user postgres:         // Enter your password

Once you have logged in as admin, create a new user with the following command:

CREATE USER oop PASSWORD 'ucalgary';

Now that you have created a new user, you're ready to run the program. In the program, we handle the creation of the database for you.

Running the Program

To run the program, follow these steps:

As mentioned earlier, ensure you have the following folder structure:

Open a terminal window and navigate to the project directory. 3. Run the following command to compile the program: // Assuming .jar files in lib/

javac -cp ".;./lib/*;src/main/java/" .\src\main\java\edu\ucalgary\oop\*.java  

4. Run the following command to run the program: // tag could be "location" or "central"

java -cp ".;./lib/*;src/main/java/" edu.ucalgary.oop.MainApplication --worker-type=<tag>  

5. Follow the on-screen instructions to use the program.
6. Press Ctrl + C to force quit the program.
7. To exit the program, follow the instructions in the next section.
8. To view the Javadoc documentation, follow the instructions in the Additional Information section.
9. To set up the database, follow the instructions in the Additional Information section.
10. To run the tests, follow the instructions in the Running the Tests section.
11. For additional information, refer to the Additional Information section.

Running the Tests

TODO: Complete This