Giter Club home page Giter Club logo

honor_evaluator's Introduction

Academic Honor Society Evaluator

Description

This Java program is designed to assess and manage student academic records for honor society eligibility. It reads student data (including name, credit hours, quality points, and year or degree) from a generated students.txt file, then creates appropriate Student, Undergraduate, or Graduate objects. The program calculates the average GPA, sets a dynamic threshold for honor society eligibility, and displays a report listing eligible students. It's structured as a Maven project with separate modules for data generation and core functionality, and includes a suite of JUnit tests for validation.

User Guide

Option 1: Run Program Without Maven (Using Downloaded Source Files)

Step 1: Download Source Files

  1. Navigate to the project's repository.
  2. Download the source files as a .zip file and extract them to a local directory.

Step 2: Compile the Java Files

  1. Ensure you have Java installed on your system. You can download it from Oracle's Java website.
  2. Open a terminal or command prompt.
  3. Navigate to the extracted project directory.
  4. Compile the Java files using the command: javac project2/*.java.

Step 3: Run the Program

  1. Once compiled, run the program using: java project2.Project2.
  2. Ensure students.txt is in the correct directory as expected by the program (usually in project2/target/generated-sources/).

Option 2: Set Up and Run as Maven Build

Step 1: Clone or Download the Repository

  1. Clone the repository using Git or download the source code as a .zip file from the project's repository.

Step 2: Install Maven

  1. If not already installed, download and install Apache Maven from Maven's official website.
  2. Follow the installation instructions provided on the site.

Step 3: Build the Project

  1. Open a terminal or command prompt.
  2. Navigate to the project's root directory.
  3. Run the Maven build command: mvn clean install.
  4. This command compiles the project and generates the students.txt file.

Step 4: Run the Program

  1. After a successful build, navigate to the target directory within the project.
  2. Run the program using: java -cp . project2.Project2.

honor_evaluator's People

Contributors

sllozier avatar

Watchers

avatar

honor_evaluator's Issues

Code Review

Complete code review

Project Structure and Config:

  • Follows Maven's standard directory layout.
  • pom.xml correctly configured (groupId, artifactId, version).
  • Dependencies necessary, up-to-date, and conflict-free.
  • Proper plugin configurations.

Code Quality:

  • Code readability and maintainability
  • Adherence to coding standards.
  • Effective error handling and logging.
  • Adequate unit test coverage.

Build Process:

  • Efficient build steps.
  • Correct Maven lifecycle phases.
  • Valid custom build scripts/modules.

Dependency Management:

  • Appropriate dependency scopes.
  • No unused/outdated dependencies.
  • Necessary dependency exclusions.
  • Check for security vulnerabilities in dependencies.

Documentation:

  • Updated pom.xml and project documentation.
  • Adequate inline comments and documentation.

Performance:

  • Maven configuration optimized for performance.
  • Configuration for parallel builds, if applicable.

Security:

  • No security vulnerabilities in dependencies.
  • Sensitive data properly secured.

Code Complexity:

  • No overly complex methods/classes.
  • Static code analysis to identify issues.

Best Practices:

  • Adherence to Maven best practices.
  • Easy for new developers to understand/setup.

Testing Requirements

I must have both positive and negative tests for each class:

StudentTest:

  • Positive Test 1
  • Positive Test 2
  • Positive Test 3
  • Negative Test 1
  • Negative Test 2
  • Negative Test 3

UndergraduateTest:

  • Positive Test 1
  • Positive Test 2
  • Positive Test 3
  • Negative Test 1
  • Negative Test 2
  • Negative Test 3

GraduateTest:

  • Positive Test 1
  • Positive Test 2
  • Positive Test 3
  • Negative Test 1
  • Negative Test 2
  • Negative Test 3

Project2Test:

  • Positive Test 1
  • Positive Test 2
  • Positive Test 3
  • Negative Test 1
  • Negative Test 2
  • Negative Test 3

Complete README

Items to add to README

  • Personalize User Guide
  • Format title area
  • Add UML
  • Add contact information
  • Add helps section

Comments

More detailed comments to code:

  • student-data-module: StudentData.java, StudentDataTest.java
  • main: Graduate.java, Project2.java, Student.java, Undergraduate.java
  • test: GraduateTest.java, Project2Test.java, StudentTest.java, UndergraduateTest.java

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.