CS-2810 Final Project Submission Guide
Uploaded by
Bo StevensCS-2810 Final Project Submission Guide
Uploaded by
Bo StevensCommon questions
Powered by AIEclipse's tool for exporting to a .jar file is not recommended in this project because it fails to properly compile and package the program when the code is divided across multiple projects. The tool can output a .jar file but it results in a version that crashes immediately because it does not include all necessary dependencies and submodule code required for execution. The project's unique structure requires an alternative method provided by Gradle to ensure all components are correctly included and functional .
Verifying application functionality via a .jar file is significant in the project because it demonstrates that the exported program can perform as expected when run outside of the development environment. This verification step ensures that the program's functionality is preserved through the export process and that users experience the intended performance and features when running the .jar file. It is a critical step in ensuring the application meets the project's requirements for functionality, as showcased in the associated video .
It is recommended to perform the .jar export steps on a Windows machine because the checklist instructions and steps provided are specifically tailored for execution within a Windows environment. The tooling and scripted commands, such as using Powershell to open a terminal and executing Gradle build commands, are designed with Windows compatibility in mind, which ensures a smoother and more controlled export process .
Pushing changes to GitHub improves the collaborative development process by enabling team members to access the most recent code, review changes, and integrate their work seamlessly. It facilitates collaborative editing, version tracking, and conflict resolution. Moreover, it allows for a transparent history of changes which is invaluable for project management and accountability, ensuring that the code repository reflects the latest version of the project across all checkpoints .
Gradle plays a critical role in the build process by automating the compilation and packaging of the program into a .jar file that includes all necessary components across multiple projects. Unlike traditional single-project exports, Gradle manages dependencies, compiles the project, and creates a distribution package that ensures the program runs correctly post-export. Its use allows the project to handle complex build configurations efficiently and ensures that the final output .jar file includes all needed components to execute without errors .
The inclusion of a video in the verification process serves as a benchmark for the expected performance and functionality of the application. By comparing the functionality of the application as exhibited in the .jar file to the video, developers can verify whether the application performs correctly and meets the project's specified requirements. It ensures consistency between what was developed and what is actually delivered, acting as a quality assurance measure .
The primary challenge in exporting a Java program as a .jar file for this project is that the program is split across multiple projects that need to be exported together. Eclipse's tool for exporting to a .jar will not work because it outputs a file that crashes immediately. This issue is resolved by using Gradle, which allows for proper compilation and packaging of the program across the multiple projects. The specific command for this, which should be run in a terminal on a Windows machine, is './gradlew desktop:dist'. This generates a .jar file in the Desktop -> build -> libs directory that can be properly executed .
To successfully export a program using Gradle in this project, the following steps should be followed: First, locate the project directory and open a terminal, preferably a Powershell window on a Windows machine. Then, navigate to the directory containing the Gradle build script and execute the command './gradlew desktop:dist'. This command compiles the program into a .jar file, which is then located in the Desktop -> build -> libs directory. The correct setup ensures that the .jar includes all projects and dependencies, hence it will function correctly when executed .
The project ensures version control and code tracking through the use of GitHub repositories. All code from various development checkpoints (checkpoints 0 through 6) must be pushed to the GitHub repository. This process allows for meticulous tracking of code changes, maintaining a history of modifications, and ensuring that all team members have access to the most current version of the code across all development stages .
The consequences of not verifying the functionality of the application using the .jar file could include the risk of the application not functioning properly when run outside the development environment, user-facing errors, crashes upon startup, or missing features that were assumed to be working. Verification via the .jar file is essential to ensure compatibility and performance in real-world usage, thereby validating the program's readiness for deployment .