Contributing Guidelines

Development

Prerequisites

Java Development Kit (JDK) (recommended version 19)
Apache Maven (recommended version 3.8)

Setup

Clone the repository

git clone https://github.com/punitarani/cse360-project.git

Open the project
- Preferably, use IntelliJ IDEA to open the project.
- Visual Studio Code can also be used.
  - Required Extensions:
    - Extension Pack for Java
- Command line works as well but is not recommended.

Build and Run

Use Maven IntelliJ IDEA plugin or VS Code extension to build and run the Project.

Maven -> Plugins -> javafx -> javafx:run

Command line instructions are provided for reference:

Build: mvn clean package
Run: mvn clean javafx:run