Universal Modeling Language Software Development Kit

• v1.0.30
• How to read version # Version main branch.release branch.pull request changes'
• Login Information: username: admin password: password it's "currently hard coded" (future Gson/SQL)
• What's New
• 1. Application can be launched in GUI

Table of Contents

1. Overview
2. Features
3. Getting Started
4. Installation
5. Running the Application
6. Usage
7. Configuration
8. Testing
9. Contributing
10. License
11. Contact

Overview

DevKitUML is a unified modeling language (UML) software development kit (SDK) designed to simplify the process of generating, managing, and interacting with UML diagrams for developers. This project leverages JavaFX for a rich graphical user interface and integrates a console-based interface for additional functionality.

This SDK is intended to streamline the experience of creating class diagrams, modifying them, and saving/loading project data using JSON format for persistence.

Screenshots

A brief description of the screenshot.

Features

• Graphical User Interface (GUI): Built with JavaFX, users can interact with the software to create and manage UML diagrams.
• Command-Line Interface (CLI): Provides a terminal-like environment where users can execute commands within the JavaFX terminal window.
• Customizable Menus: The software includes a fully interactive menu system for managing settings, help sections, and other tools.
• JSON Integration: Uses Gson for saving/loading the project data in JSON format.
• Multi-platform Support: Designed to work on Windows, macOS, and Linux with cross-platform capabilities.

Getting Started

Prerequisites

To build and run this project, you'll need:

• JDK 22 (configured in Maven with JavaFX dependencies)
• Maven for dependency management and building the project

Dependencies

The project uses the following dependencies, which are defined in the pom.xml file:

• JavaFX (v21.0.1) for graphical interface (controls, graphics, fxml, media, web, swing).
• Gson (v2.8.9) for handling JSON serialization/deserialization.
• JUnit (v5.10.2) for unit testing.
• ControlsFX (v11.2.1) for additional UI controls.
• TilesFX (v21.0.3) for dashboard-like tiles.
• FXGL (v21.1) for game development capabilities (future feature extensions).

See the pom.xml file for full details on dependencies.

Building the Project

Installation

Prerequisites

Before running the project, ensure you have the following installed:

• Java JDK 22 or later
• Maven 3.6 or later
• JavaFX (already managed through Maven dependencies)

Step-by-Step Instructions

1. Clone the repository:

   
   git clone https://github.com/hbarton2/cscd350-f24-TeamNull.git
   cd projectname

2. Build the project using Maven:

   
   mvn clean install

3. Run the project:

   
   mvn javafx:run

Running the Application

To run the project, execute the following command:

mvn javafx:run

Alternatively, you can use your favorite IDE, such as IntelliJ IDEA, with Maven integration.

Usage

Console Interaction

The application includes an in-app terminal/console feature, allowing users to input commands within the JavaFX interface. Users can enter specific commands for various operations such as creating, renaming, and removing classes, attributes, and methods.

• Help Menu: Users can access the help menu for detailed guidance.
• Command-Line Operations: Integration of the command-line terminal where you can execute operations directly without leaving the graphical interface.

JSON Integration

The project uses Gson for storing and loading UML project data as JSON files. The data includes class names, attributes, and methods, allowing for an easily shareable format.

Unit Testing

JUnit is used for unit testing throughout the project. To run the tests, use:

mvn test

Configuration

Testing

To run unit tests, execute the following command:

mvn test

Testing is performed using JUnit 5 and includes:

• Unit tests for core functionalities.
• Integration tests for external API calls.

You can find tests under the src/test directory.

Contributing

License

Please see LICENSE.md

Contact

For any inquiries, feel free to reach out to:

• TEAM NULL
• GitHub: https://github.com/hbarton2/cscd350-f24-TeamNull

Acknowledgments

• Special thanks to DEVELOPERS, DEVELOPERS, DEVELOPERS!!!