Calendar Application

Documentation

We have created a UML Sequence Diagram and a UML Class Diagram. For each, we have provided a simplified version and a detailed version. The simplified version includes all important classes and methods, but may miss some connections between classes. The detailed version is computer generated so it includes everything, but it also includes too much information which makes it harder to understand.

How to Build/Run

Option 1: VS Code

Setup for VS Code

  1. Install Java JDK 17
  2. Install the extension "Extension Pack for Java"

Running with VS Code

  1. Follow instructions under "Setup for VS Code"
  2. Open the file Calendar.java, located in the folder calendar/src/main/java/com/calendarhw2
  3. Go to the main method, click on the run button

Building the JAR File with VS Code

Don't. Use Terminal instead.

Option 2: Terminal

Setup for Terminal

  1. Install Java JDK 17
  2. Install Maven version 3.6 or above. Preferred version is 3.8.4

Building JAR with Terminal

  1. Follow instructions under "Setup for Terminal"
  2. To build the project JAR file execute the below command in the project directory calendar

    mvn clean compile assembly:single

Running with Terminal

In the previous step the .jar file was built, we will now run it.

  1. Follow instructions under "Setup for Terminal" and "Building with Terminal"
  2. CD to the directory target/
  3. Run the jar executable using the below command

    java -jar Calendar.jar