CSC/ECE 517 Spring 2022 - E2245: View for results of bidding: Difference between revisions
Line 93: | Line 93: | ||
== Testing == | == Testing == | ||
# Run and pass the | # Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases) <br> | ||
# Test the UI for the deployed project.<br> | # Test the UI for the deployed project.<br> | ||
Revision as of 14:57, 14 April 2022
CSC/ECE 517 Spring 2022 - E2245: View for results of bidding
Problem Statement
When students sign up for topics, they are presented with a system to bid on their favorite topics. This process is allowed for both individual students as well as teams. As a result, many students will first sign up for topics, which can reduce the number of teams that get their first pick, and result in long waitlists. There are several bidding algorithms available to the instructors to give as many groups as possible their first choice. As this is an NP-complete problem, the algorithm has to use heuristics to guess efficiently. There needs to be a way for instructors to easily view and compare the results of the bidding algorithms to get a quantitative sense of their effectiveness.
Project Goal
This project aims to solve this issue by giving clear and concise feedback of the algorithms in topics list in the assignment. However, since topics in the table potentially have several fields, care must be taken not to overcrowd the table with information. There are several different UI/UX approaches to display this information, and the chosen one should:
- Maximize useful information at a glance, while minimizing clutter
- Fit into the flow of the topic page
- Allow further information to be obtained if requested
- Not be visible if bidding is not used
Some other miscellaneous goals of this project are to:
- Remove topic fields from view if they are not applicable
- Refactor code
- Increase test coverage
Previous Work
Current User Cases
Below is the use case diagram that depicts the existing use cases that associated to the topics bidding features of the application. Notice that in order to check some bidding information for a topic/project, the Instructor has to impersonate a student.
Current Work Flow Diagram
Improvement on the Previous Work
Change in Use Cases
Student: This actor is responsible for submitting and deleting bids for topics while the topic selection period is open for an assignment which uses the new lottery topic selection mechanism.
Instructor: This actor is responsible for updating an assignment to use the new lottery topic selection as well as closing the bidding period and beginning the automatic topic selection. Instructor is also able to view the progress details of bids without having to impersonate students
UI design
Before:
Proposed UI
Change in Work Flow Diagram
Class Diagram
Code changes
The following files will be changed to fulfill the requirements
Controllers:
- app/controllers/sign_up_sheet_controller.rb
- app/controllers/review_bids_controller.rb
- app/controllers/lottery_controller.rb
Models:
- app/models/bid.rb
Views:
- app/views/sign_up_sheet/list.html.erb
- app/views/assigments/edit/_topics.html.erb
Rspec:
- spec/controllers/sign_up_sheet_controller_spec.rb
- spec/controllers/big_spec.rb
- spec/controllers/review_bids_controller_spec.rb
- spec/controllers/lottery_controller_spec.rb
Refactor Code to follow good coding practices
Example:
- Rename method names more meaningfully and intuitive.
Functionalities added
- The instructor should be able to see how many teams have bid for each topic without having to impersonate students
Testing
- Run and pass all the RSpec Tests (including the existing ones - regression, and the newly added cases)
- Test the UI for the deployed project.
UI Testing
Instructor View
- username: instructor6
- password: password
Student View
- username: student575
- password: password
Future Work
- Place holder for potential ed-cases that might get missed
Team Roster
- Duy Nguyen - dvnguye3@ncsu.edu
- Kwon HyeokJun - khyeokj@ncsu.edu
- Shawn Salekin - ssaleki@ncsu.edu
- David Glymph - dwglymph@ncsu.edu
Mentor: Ed Gehringer - efg@ncsu.edu