GourmetJava

Welcome to Gourmet Java's UML Editor! This is where you can find information about what the project does and how to use it.

Table of Contents

• Introduction
• Features
• Installation
• UML-Editor
• Error-Code
• Programmers

Introduction

With this UML Editor you can make UML structures for a Java project you have in mind using your terminal of choice.

Features

• Feature 1: Build and manipulate classes using a CLI or GUI interface.
• Feature 2: Add and manipulate class attributes.
• Feature 3: Add and manipulate relationships between classes.
• Feature 4: Save and Load the UML Project.
• Feature 5: Help option to instruct user how to use the program.

Installation

To run the UML Editor you need to have the most recent Java Virtual Machine installed(JVM). After having JVM installed you can use different techniques to run the program which are using an IDE, a terminal, or Gradle to run the program.

This Installation guide will walk you through the process of installing a JVM and Gradle an open-source build automation tool.

Java Installation

For Windows

1. Open up your browser of choice.
2. Go to Oracle's website to download the most recent version of Java for Windows.
3. Follow Oracle's installation guide for Java.
4. Go to C:\Program Files\Java\jdk-20\bin or wherever your bin file is located for Java. Copy the path of your bin file.
5. Open up Window's Start and go to Edit the System Enviroment Variables.
6. Select Environment Variables → navigate the System variables window and look for Path and double-click it → click new → and then paste the bin path into the the new line → click okay out of all windows to apply changes.
7. Open a command prompt.
8. In the console enter java --version to check that JVM was properly installed.

For Linux

1. Open a terminal.
2. Enter sudo apt install openjdk-19-jre-headless. Enter ls to see if the rpm file is present.
3. In the terminal enter java --version to check that JVM was properly installed.

Running-The-UML-Editor

For Windows

1. Download zip file from Github or clone the repository for GourmetJava.
2. Open cmd.
3. Go to the folder that has the GourmetJava File.
4. Run the Java project. Enter java -jar build/libs/shadow.jar.
5. Press 'c' or 'g' respectively for the CLI or GUI interface.

For Linux

1. Download zip file from Github or clone the repository for GourmetJava.
2. Open terminal.
3. Go to the folder that has the GourmetJava File.
4. Run the Java project. Enter java -jar build/libs/shadow.jar.
5. Press 'c' or 'g' respectively for the CLI or GUI interface.

Programmers

• Rachael D
• Karen C
• David P
• Ben K
• Michael S