Skip to content

ReelRec v1.0 Release

Choose a tag to compare

View all tags
@ashmod ashmod released this 13 Apr 13:59
· 11 commits to main since this release
v1.0
444672a

We are pleased to announce the first official release of ReelRec, a movie recommendation system designed to generate personalized movie recommendations based on a curated movies file and user watch lists.

What's New in v1.0

  • Dual Interface Support:
    • GUI Application: An intuitive graphical interface with a splash screen, configuration panel, and integrated window-based interactions.
    • CLI Application: A command‑line mode that allows users to run the application non‑interactively or interactively via console prompts.

  • Default Resources Included:
    • Sample movies.txt and users.txt files are provided in the resources/ directory.

  • Robust File Validation:
    • Validates input files and provides user‑friendly error messages through both interfaces.

  • Integrated Packaging:
    • Executable JAR files for both GUI and CLI applications are included. The GUI application displays as a standard window (complete with taskbar support and full window controls).

Folder Structure

  • reelrec-1.0: Contains the executable GUI application (jar file and optional startup scripts).
  • reelrec_CLI: Contains the executable CLI application (jar file and optional startup scripts).
  • resources: Default input files (movies.txt and users.txt).
  • README.txt: Includes detailed usage instructions and system requirements.
  • LICENSE: License information for the project.

Installation & Usage Instructions

  1. Download and Unzip:
    Download the release package (named ReelRec_1.0.zip) and extract it to a directory on your system.

  2. For the GUI Application:

    • Navigate to the reelrec-1.0 folder and run the executable jar file: 
      java -jar reelrec-1.0.jar
    • The application will start with a splash screen and then present a configuration panel. You may either use the default resources or select custom files using the built‑in file browsers.
    • Once you confirm your settings, the app processes the data and generates recommendations in the specified output file.

  3. For the CLI Application:

    • Navigate to the reelrec_CLI folder.
    • Run the CLI jar via the command line: 
      java -jar reelrec_cli.jar [moviesFilePath] [usersFilePath] [recommendationsFilePath]
    • If no arguments are provided, the application will prompt you for file paths interactively using console input.
    • The default paths are:
      • Movies File: resources/movies.txt
      • Users File: resources/users.txt
      • Recommendations Output: recommendations.txt

System Requirements

  • Java Runtime Environment (JRE) version 8 or later is required for both the GUI and CLI applications.

Future Work

Future releases will aim to expand features such as:

  • Enhanced recommendations algorithms.
  • Improved user interface and configuration options.
  • Extended support for additional data sources and file formats.

Licensing

This project is licensed under the terms specified in the included LICENSE file.

Assets 3
Loading