lavinrp/bmabackstage

Manage instructor and student information for BMA

bmabackstage's Issues

List Belts to Order

User Story

As the owner I want to get a list of belts to order for testing to simplify the belt order process.

Details

• This is covered by ProgressionStage and IRequirement
• Create a page available to owners/admins with list of all students who are likely to test
  • This view of students should highlight their belt color, and size
• Based on the current progression of each student recommend ordering the next belt in their current belt size.
  • Belt size on student will need to be updated manually

Add Student to Class

User Story

As a staff member I want to add a student to a class so that the instructor can manage the student with the rest of the class

View Recently Expired Contracts

User Story

As a front desk worker I want to know what contracts have recently expired so that I know who needs to renew their contract.

Update Instructor Assignments

User Story

As the owner I want to change what instructors / assistants are normally teaching what classes so that I can react to changes in staff

Design Data Model

Plan the initial design of the data model.
This does not need to be set in stone, but should be as close as possible to the general shape of the final design.

Scheduled Classes Overview

User Story

As the owner I want to see an overview of all of the classes

List Previous Students of the Month

User Story

As an instructor I want to list the previous students of the month so that I can make sure different students are given the award

Details

See #22

List Testing Students

User Story

As the owner I want to get a list of all testing students so that I can print cards for them

Select DB

We will need to determine what database (or databases) we will be using for the project.
The database should be compatible with Entity Framework Core to make integration with ASP easier.

We don't need to decide exactly where they will be hosted yet, though we should keep that in mind.
Preferably the selected Db will be easy to setup locally for developers and for the Github Actions CI runner.

View Student Emergency Contact Info

User Story

As an instructor I want to be able to view a students emergency contact information so that I can contact the appropriate people during an emergency.

Details

• Create a component for viewing emergency contact info
• This component should be visible through the main student view
• This This component should be quick to access
• This component should support calling the emergency contact phone number

Remove Student From Class

User Story

As a staff member I want to remove a student from a class so that former students do not clutter the roster

Setup Github Actions

Create a Github action for running unit/integration tests for the project.
Create a Github action for running static analysis on the project.
Create a Github action for running code coverage on the project.

Student Notes

User Story

As an instructor I want to be able to leave notes about a student so that other instructors can be aware of behavioral/medical issues

Details

• Notes should be fully visible from the full student view
• Small student views (like displayed in the student list) should just indicate if any notes are present for the student

View All Students of the Month

User Story

As a master I want to list all of this months students of the month so that I can print their awards

Details

• Create a student list populated with just students of the month for all classes.
• This should be available in some page for masters/owners/admins

View Student Info

User Story

As an employee I want to have a single place where I can view all details of a student so that I don't have to go searching all over the application for various student information.

Details

Create a StudentDetails component where all student information will be displayed

Flag Expired Contracts for Instructors

User Story

As an instructor I want students with expired contracts to be flagged so that I know who is not allowed on the floor.

Details

• When viewing a list of students the students with expired contracts to be clearly marked
• The student view should have contract status clearly visible when the contract has expired

Brainstorm initial user stories

Overview

These user stories are not all necessary for the first release.
A separate effort will be made to select user stories for the first sprint.

Below are the currently proposed user stories.
The stories here when the discussion is over will be converted into Issues.

---

Proposed Stories

Every day class activities

1. As an instructor I want to mark students attendence so that I know when they have met the attendence requirement for testing.
2. As an instructor I want to get a list of the classes that I teach so that I know when I'm expected to teach and know the details of the class that I will be teaching.
3. As an instructor I wan to get a list of all of the students in a particular class so that I know basic information about each sutdent that I will be teaching.
4. As an instructor I want to view the names of the kata and takedowns that a student should be currently working on so that I can teach them the correct information.
5. As an instructor I want to indicate that I have taught a class so that I can be payed for it.
6. As an instructor I want to be able to leave notes about a student so that other instructors can be aware of behaviorial/medical issues
7. As an instructor I want to be able to view a students emergancy contact information so that I can contact the appropriate people during an emergancy.
8. As an instructor I want students with expired contracts to be flagged so that I know who is not allowed on the floor.
9. As an instructor I want to be notified of announcements that need to be made so that I can keep my class informed of upcoming events
10. As an instructor I want to mark a student as student of the month so that a student of the month award can be printed
11. As an instructor I want to list the previous students of the month so that I can make sure different students are given the award
12. As a master I want to list all of this months students of the month so that I can print their awards

Testing

1. As an instructor I want to mark students as having passed pre-testing so that Shihan knows which students can pay for testing
2. As an instructor I want to mark students as having turned in terms and history so that Shihan knows which students can pay for testing
3. As an instructor I want to get a list of students who have enough classes to test so that I know who to pre-test.
4. As an instructor I want to get a list of students who have met all requirements for testing (classes, pre-test, terms, history) so that I can send an email to their parents notifying them about testing.
5. As a master I want to check if a given student has met all requirements for testing (classes, pre-test, terms, history) so that I can take their payment for testing.
6. As the owner I want to get a list of belts to order for testing to simplify the belt order process.
7. As an employee I want to check what a given student needs to be elegable to test so that I can tell their parent why they aren't testing.
8. As an instructor I want to update a student's rank after a successful testing so that their information is up to date
9. As the owner I want to get a list of all testing students so that I can print cards for them

Management

1. As the owner I want to check which instructors have been teaching on which days so that I can easily do payroll.
2. As the owner I want to view what instructors / assistants are normally teaching what classes so that I can plan when adding/removing staff
3. As the owner I want to change what instrutors / assistants are normally teaching what classes so that I can react to changes in staff
4. As a master I want to check to see what instructors have taught a student on what days so that I can make corrections to instructors when things go wrong.
5. As the owner I want to add and remove classes from the schedule so that I can keep the class list up to date
6. As the owner I want to see an overview of all of the classes

Enrollment

1. As a staff member I want to add a student to a class so that the instructor can manage the student with the rest of the class
2. As a staff member I want to remove a student from a class so that former students do not clutter the roster
3. As a front desk worker I want to know what contracts have recently expired so that I know who needs to renew their contract.
4. As a front desk worker I want to query the contract status of a student so that I know when their contract will expire.
5. As a front desk worker I want to know what contracts are about to expire so that I know who needs to renew their contract

List Students who can Pay for Testing

User Story

As a master I want to check if a given student has met all requirements for testing (classes, pre-test, terms, history) so that I can take their payment for testing.

Details

• This is covered by ProgressionStage and IRequirement
• Create a view for masters to see who can pay.
• Provide a way for masters to see why a student isn't ready

Mark Students for Testing

User Story

As an instructor I want to mark students as having passed pre-testing so that Shihan knows which students can pay for testing

Details

This is covered by ProgressionStage and IRequirement.
The things that need to be checked during pre-testing should be manual requirements on a progression stage.
Students can be automatically marked as ready for testing after all requirements in a given progression stage have been met.

View Contracts Expiring Soon

User Story

As a front desk worker I want to know what contracts are about to expire so that I know who needs to renew their contract

Track Terms and History

User Story

As an instructor I want to mark students as having turned in terms and history so that Shihan knows which students can pay for testing

Details

This is covered by ProgressionStages and IRequirement. Terms and history should be a manual requirement. The instructor should mark the requirement after terms and history have been turned in.

Check Student Contract

User Story

As a front desk worker I want to query the contract status of a student so that I know when their contract will expire.

Notify Instructors of Announcements

User Story

As an instructor I want to be notified of announcements that need to be made so that I can keep my class informed of upcoming events

Details

• Required announcements should be clearly visible in the class view

Fetch Classes for Instructor

User Story

As an instructor I want to get a list of the classes that I teach so that I know when I'm expected to teach and know the details of the class that I will be teaching.

Details

• Create a component for listing classes
• Create system that can filter all classes for just the classes taught by an instructor
• Should work on desktop and mobile

List Students in Class

User Story

As an instructor I wan to get a list of all of the students in a particular class so that I know basic information about each student that I will be teaching.

Details

• Create a component for listing students

Credit Instructor for Class

User Story

As an instructor I want to indicate that I have taught a class so that I can be payed for it.

Details

• The instructors that usually teach a class should automatically get set
• Only require changing anything if different instructor is teaching or if an instructor is absent

Check Why Student Cant Test

User Story

As an employee I want to check what a given student needs to be eligible to test so that I can tell their parent why they aren't testing.

Details

• This is covered by ProgressionStage and IRequirement
• The student view should have a component displaying all of the progressions that the student is training in
• By selecting a progression the employee should be able to see what requirements have not been met for the current progression stage.

View Student Requirements

User Story

As an instructor I want to view the names of the kata and takedowns that a student should be currently working on so that I can teach them the correct information.

Details

• Create a component for viewing an IRequirement
• Create a component for viewing a ProgressionStage
• These components will most likely be displayed in the student view and potentially in the class view.
• Should work on desktop and mobile

List Employee Time Sheet

User Story

As the owner I want to check which employees have been working on which days so that I can easily do payroll.

Setup initial ASP.net core project

Create the backend project and establish basic project structure.

No reason not to use the latest ASP.net core available.
Set up the project with nullable reference types.
Warnings as errors.

Mark Student of the Month

User Story

As an instructor I want to mark a student as student of the month so that a student of the month award can be printed

Details

• Likely requires expanding the domain model
• Create a component for selecting a student from a list of students
• Create component for selection the student of the month for a class
  • Should allow for selecting between different months. (should default to current month)
  • Should indicate which students have recently been awarded (past 1 or 2 months)
  • Should be highlighted when a new student of the month is needed .

Update Class Schedule

User Story

As the owner I want to add and remove classes from the schedule so that I can keep the class list up to date

List Instructor Class Assignments

User Story

As the owner I want to view what instructors / assistants are normally teaching what classes so that I can plan when adding/removing staff

List Instructors of Student

User Story

As a master I want to check to see what instructors have taught a student on what days so that I can make corrections to instructors when things go wrong.

Check Class Count for Testing

User Story

As an instructor I want to get a list of students who have enough classes to test so that I know who to pre-test.

Details

• Provide a view of students who are X classes from completing their LessonRequirement (Where X is some user input number)
  • Can't check for Lesson Requirement to be complete because we pre-test before the requirement is complete.

Update Student Rank

User Story

As an instructor I want to update a student's rank after a successful testing so that their information is up to date

Setup Automated Tests

Depends on #2

Setup a test project/projects for Unit/Integration tests.
These tests should be compatible with github actions.

Support Marking Attendance

User Story

As an instructor I want to mark students attendance so that I know when they have met the attendance requirement for testing.

Details

• Should be able to quickly mark all of the students who are normally in the class
• Should be able to manually add students who aren't normally in the class
• Should be able to change a students attendance later if incorrectly marked
• Should work on both desktop and mobile