ReadME

This is the ReadMe File for EECS 2311 Group 1 Winter 2024


View Demo . Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Set Up
• Usage
  • Launching the Main Application
  • Exploring Functionalities
    • Logining in and Authentication
    • Dashboard
    • Rating
    • Favourites
    • Analytics
    • Email Feature
  • Sign Out - the Main Application
  • Running Test Cases Only
• Contributing
• Authors
• Acknowledgements

About The Project

The Show/movie Tracking web app is designed for users who do not have streaming subscriptions but would still like to know about upcoming movies/TV shows. The web app provides an in-time notification up to their preference, recommends trending shows on major streaming platforms like Netflix, Prime, etc., and gives users a thread-like comment place that allows users to develop deep discussions to share their thoughts with friends or people who are also into the shows. It also functions as an integrated hub that saves users the trouble of jumping from one platform to another.

Built With

Java Swing

Java

DB Browser(Database)

Getting Started

Prerequisites

Before you begin, ensure you have the following software installed on your system:

1. Git - Version Control

2. Eclipse Community edition - The IDE to asociate the code with. Here, eclipse is primarily used.

3. Java Development Kit (JDK) version 8 or above: JDK is required to compile and run the Java application. Ensure JDK 8 or later is installed on your system. Download JDK

4. Maven: This project uses Maven for managing dependencies and building the application. Maven simplifies the process of including external libraries such as JDBC drivers for SQLite, JFreeChart, and JavaMail API in the project. Ensure Maven is installed on your system. Download Maven

Installation

To run Show Tracking web app, ensure you have Java installed on your system. Follow these steps:

1. Clone the repository: git clone https://github.com/vaghani-shreya/EECS_2311_Group_Project.git
2. Navigate to the project directory: cd EECS_2311_Group_Project
3. Run Maven Build: Execute mvn clean install to build the project and download the necessary dependencies automatically.
4. Run the application: Use the command java -cp target/classes front.loginpage to run the application.

GitHub - https://git-scm.com/ Eclipse Community edition - https://www.eclipse.org/community/ Java - https://www.oracle.com/ca-en/java/technologies/downloads/ (jre version 1.8)

Set Up

1. Clone project - git clone https://github.com/vaghani-shreya/EECS_2311_Group_Project.git
2. Import Project in eclipse
3. Make sure after Importing, there is a library called Maven Dependencies in the project folder as shown below If the maven dependencies cannot be resolved, sync maven dependencies https://maven.apache.org/

Usage

Launching the Main Application

Follow the steps to launch the application:

1. Locate the LoginPage.java found under src/front/LoginPage.java in the Project folder and right click on it, scroll down to the Run option and click on Java Application to Launch the application. The process is witnessed in the Image below

   

NOTE - It takes a few seconds to Launch the Application as it is connected to a database and parsing data from the database

Exploring Functionalities

Logining in and Authentication

You can use the username - user , password - password to login into the system and explore the application. You can also register as a new user by entering a new email you'd like to set as your username and enter a new password. Then click register.

A pop-up window should appear letting you know you have successfully registered.

If you forgot your password or want to change it. Click forgot my password then enter your username then press Enter.

The verification window will appear where you should enter the code that has been sent to your email.

If you have an existing account simply enter the username and password and click Login.

After Logging into the Main Application, you can click on the different tabs to checkout the different features Dashboard, Ratings, Favourites page, and Analytics

Dashboard

There are three different tabs under the dashboard which can be explored Netflix, Disney,and Amazon.

To search for a specific show enter the title of the show and press Search.

To further filter based on genre, Type, or ratings you can click on the drop-down arrow by the search button. Select the filter by clicking then enter the genre, rating, type etc. then press search.

You can further sort by date added, release year, and title. Follow the same steps as above.

To see additional information about the specific show click on a show panel. A pop-up window should appear.

Here you can add a show to your favourites list.

You can also mark the show as watched.

Rating

Similarly to dashboard there are three different tabs under ratings which can be explored Netflix, Disney,and Amazon. The main difference is included when you click on an individual show. Once Clicked this pop up window should appear. With an Add Rating functionality as well as Add Comment.

To Enter a rating and/or comment type a rating between 1-10 and a comment in their respective search fields. The press save or save comment.

When rating is complete a pop window should appear informing you the rating was complete.

Similarly when a comment is added it will appear in show details.

Favourites

If you click on favourites page you can see your favourite list of shows.

If you click on any show you can see further details and delete any show added to the list by clicking Delete

Analytics

The Analytics page displays the number of shows in each platform which have a certain age rating associated with it.

Email Feature

The email feature is automated to be sent weekly. To test this feature:

In the newsletter.java file go to the sendEmail method and enter the correct password.

Then run the application again and log in with your email. You should recieve an email automatically. The next email will be sent in a week.

Sign Out - the Main Application

To Sign out from the Main application, click on the Sign out button on the right hand side of the application.

Running Test Cases Only

The Java SQL error "No suitable driver found for "jdbc:sqlite:database/UserCredentials.db" is supposed to occur since we are testing hardcoded values. But the database is tested in the databaseTest.

For the following error multiple pop-up windows should appear in your task bar. Continuously press "ok" and the test cases should pass.

Authors

• Mai
• Elizabeth
• Anusha
• David
• Shreya

Acknowledgements

• Thanks to Hadi Hemmati, the EECS 2311 instructor and Hamed Taherkhani, the TA, for their invaluable guidance.

=======

License

Authors

Anusha - Forgot Password, Newsletter, Mark as Watched David - Favourites List Elizabeth - Login Authentication, Registration, Sort and Filter Mai - Discover From, Favourites List, Show Details Shreya - Discover From, Ratings and Comments, Chart Analytics

Acknowledgements

• Thanks to Hadi Hemmati, the EECS 2311 instructor and Hamed Taherkhani, the TA, for their invaluable guidance.
• Special thanks to JFreeChart for the charting tools.

d2c9357061c05c44d93b3e9f4a61d3cdd7883354