Welcome to the UnCorked Project

UnCorked acts as a way for wine enjoyers, collectors, and experimentalists to store their thoughts on various wines that they have tried, as well as allowing them to explore different wines and potentially discover their next wine experience.

Using UnCorked you are able to access either the default database of 130k wines or upload your own to and search through them using either the "Search" page or the search bar at the top of every screen. You are then able to add wines to your favourites and wishlist which you can see in the "My Wines" screen alongside curated recommendations based on your recently viewed, favourites, and personal reviews. For each wine you can also save your personal thoughts and rating on its information page. These can then be accessed through the "Reviews" page.

All of the functions of UnCorked are easily accessible through the expanding side bar on the left side of the screen. Additionally, for more help on using the application there is a user manual in the "Manual" page that will help get you up and running with your UnCorked experience.

Authors

• Brenden Lee
• William Tingey
• Lewis Meates
• Max Shi
• Abilash Sivasith
• Morgan Lee

Prerequisites

• JDK >= 21 click here to get the latest stable OpenJDK release (as of writing this README)
• Gradle Download and Install
• Any extra CSV datasets that you may wish to use.

Run App directly from jar file

• The UnCorked application may be run directly from the downloaded .jar file

1. First the command line in seng202_2024_team2_phase2
2. Enter java -jar UnCorked-final.jar to run the application

Importing Project (Using IntelliJ)

IntelliJ has built-in support for Gradle. To import your project:

• Launch IntelliJ and choose Open from the start-up window.
• Select the project and click open
• At this point in the bottom right notifications you may be prompted to 'load gradle scripts', If so, click load

Note: If you run into dependency issues when running the app or the Gradle pop up doesn't appear then open the Gradle sidebar and click the Refresh icon.

Build Project

1. Open a command line interface inside the project directory and run ./gradlew jar to build a .jar file. The file is located at build/libs/UnCorked-final.jar

Run App from gradle build

• The application may also be run through the gradle build
• If you haven't already, Build the project.
• Open a command line interface inside the project directory and run cd target to change into the target directory.
• Run the command java -jar UnCorked-final.jar or execute startUnCorked.sh on the same directory as the jar file to open the application.

Supporting files

When run the application will automatically produce two files, these being

• data.db
• error.txt

data.db is the default database used by the system . It is produced by the class CSVService and reads the default csv wine file in the system to produce said database.

error.txt is a text document containing all the wines that failed to be read by CSVService when producing the database, these errors are stored with the intention of the viewer being able to identify the issues so faulty wines may be amended and added to the database.

These two supporting files are called when the application is initially run and whenever a new CSV is uploaded to the application.

Run Tests

• Open a terminal within the project directory and run ./gradlew test to run the JUnit and cucumber tests.