Skip to content

charlier999/GraduationRequirementViewer

Repository files navigation

GraduationRequirementViewer

A web application that allows users to search, view, and compare the different programs and courses in a university to your course schedule. This app is currently still in development with sample data from GCU's academic catalog from 2022.

Click for demonstration \/

Demo

Features

  • Search and View Academic Program Information
  • Search and View Academic Course Information
  • Create a schedule of your Course history
  • Compare your schedule against different Academic Programs
  • Admin: Import new programs and courses through import pages

Technologies Used

  • Java
  • Spring Framework Boot
  • Spring Boot Security
  • Spring Boot Thymeleaf
  • MySQL

Why the technologies were used can be found here along with additional development information.

Setup

Prerequisites

  • MySQL Server
  • Gradle version prior to 8.0

Installation

  1. Clone the repository:
git clone https://github.com/charlier999/GraduationRequirementViewer
  1. Create MySQL Database
    1. Open Create Gradview Database.sql in a text editor.
    2. On line 243, under the create users table, is an insert command to instert a user. Change the password of the administrator user, {YOUR PASSWORD HERE}, to the password you wish to use.
    3. Run the Create Gradview Database.sql script on your MySQL database.
  2. Build Application
Run the below command in the cloned repository directory.
./gradlew build
  1. Run Application
Run the below command in the cloned repository directory.
./gradlew bootRun

Now when you navigate to http://localhost:8080 you will see home page for the site.

Additional Information

Additional Information can be found here.

Guides

User Guide

Navigation Bar

THe hompage of the requirement viewer provides links to the different areas of the website.

  1. Home - Takes you to the Home page of the site.
  2. Classes - Takes you to a list of courses.
  3. Program Requirements - Takes you to a list of degree programs.
  4. Your Program Status - Takes you to the page to add you courses to a schedule and then compare them against degree programs.
  5. Login - Where the administrator signs into thier accout.

Accessing Class Information Home Page

  1. Click "Classes" in the navigation bar to be take to class home.

VIewing All Classes List

  1. Click "Classes" in the navigation bar to be take to class home.
  2. CLick "View ALl" button at the bottom of the small list of classes. You are then taken to a search results page containing all classes available to view.

Search for Class by Number

  1. Click "Classes" in the navigation bar to be take to class home.
  2. Select "number" in the search drop down menu.
  3. Then enter your query into the search bar. % is a whild card. (ex. CST% returns anything starting with CST).
  4. Then click submit. You are then taken to the search results of your query.

Search for Class by Name

  1. Click "Classes" in the navigation bar to be take to class home.
  2. Select "name" in the search drop down menu.
  3. Then enter your query into the search bar. % is a whild card. (ex. Introduction% returns anything starting with Introduction).
  4. Then click submit. You are then taken to the search results of your query.

View a Class's Details

  1. Click "Classes" in the navigation bar to be take to class home. a. Conduct a search in the search bar. b. Click "View ALl Button"
  2. Click one of the class number links. You are then taken to a class details page containing details about the class you selected.

Accessing Program Infomation Home Page

  1. Click "Program Requirements" in the navigation bar to be taken to program home.

Viewing All Programs List

  1. Click "Program Requirements" in the navigation bar to be taken to program home.
  2. CLick "View ALl" button at the bottom of the small list of programs. You are then taken to a search results page containing all programs available to view.

Search for Program By Name

  1. Click "Program Requirements" in the navigation bar to be taken to program home.
  2. Enter your word or set of letters into the search bar at the top of the page.
  3. Click submit. You are then taken to a results page containing the results of your search.

View a Program's Details

  1. Click "Program Requirements" in the navigation bar to be taken to program home. a. Conduct a search in the search bar. b. Click "View ALl Button"
  2. Click one of the program name links. You are then taken to a program details page containing details about the program you selected.

Adding Your Course History

  1. Click "Your Program Status" in the navigation bar to be taken to the schedule home.
  2. If you already have a portion of you course history still on your web browser, your schedule will be displayed to you. If not, a message saying to import your course history will be displayed instead.
  3. Click "Add/Edit Course History" link and you will be taken to the edit course history page.
  4. On the top of the page, is your current course history. The bottom of the page contains a fourm for adding your next course to your course history. Using the dropdown menu, select the course you wish to add to your history.
  5. Then check off the checkbox underneth signifying wether you have passed that course or not.
  6. Then click submit.
  7. Repeat for each course you wish to add to your history.

Comparing your Course History Against Programs

  1. Click "Your Program Status" in the navigation bar to be taken to the schedule home.
  2. If you already have a portion of you course history still on your web browser, your schedule will be displayed to you. If not, a message saying to import your course history will be displayed instead complete the "Adding Your Course History" guide before continuing.
  3. Select the program from the dropdown menu to compare against your history.

Admin Guide

Signning in as Admin

  1. Click login link in navigation bar.
  2. Enter in admin credentials that you defined when running the Create Gradview Database.sql.
  3. Click Submit.

Importing Academic Programs

  1. Login to the admin account.
  2. Click "Import" link in the navigation bar.
  3. CLick link to "Import Program" under the page title.
  4. Select a program to import into the application from the dropdown box.
  5. Click Submit.
  6. A link to the imported program and logs from importing are then displayed to you.

Logging Out of the Admin account

  1. Click "Logout" in the navigation bar.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published