Client Meetings
- Issue: Garzon was unable to log in to the system due to a role mismatch.
-
- Problem Details
-
-
- Set up as an admin instead of a professor.
-
-
-
- Incorrect link sent to him, leading to the wrong endpoint/sub-path.
-
-
-
- User ID and role mismatch caused the system confusion.
-
- Redirects Implemented
-
- Solution:
-
-
- Created a profile for Garzon in the professor table.
-
-
-
- Ella implemented redirects:
-
-
-
- If a role mismatch occurs, the system checks the user’s role and redirects to the correct page.
-
-
-
- Admins redirected back from professor pages, and vice versa.
-
- Ella is finalizing this update today and will submit a pull request.
- Onboarding Document Drafted
- Decided to mark outdated wiki pages with a note at the top:
-
- Example: "(Historical page, don’t need to read)."
- Confirm with Garzon: Is he able to log in successfully now? Has he attempted to load the data into the system? Priority: Job 1 – Garzon live on the system. NO MORE DELAYS.
- Address issue with Chrome’s login prompts affecting automated testing.
- Schedule a code review session
- Ensure all necessary information is included for effective onboarding of new group members.
- Redirect Feature
- Verify and test the redirect feature once Ella’s pull request is reviewed and merged.
- Identify and clean up any outdated content in the wiki.
- Finalize onboarding documentation and ensure the wiki is well-organized.
- Time is running out; prioritize critical tasks (e.g., Garzon’s login issue and data loading).
- Explore ways to handle Chrome’s repetitive login prompts.
- Garzon’s system access and a successful code review session are top priorities.
- Follow up promptly with Garzon and team members to prevent delays
- Pushed the work to the repository last night.
- Wiki Updated
- Comprehensive onboarding kit added to the GitHub repo.
- Sections included:
-
- Frontend architecture (React app).
-
- API architecture.
-
- Database structure.
-
- Run guide (still in progress).
- Bug Fixes
- Updated the repository's issues list for ongoing maintenance.
- Dr. Garzon Contacted. Reached out to Dr. Garzon for feedback and guidance. Awaiting response.
- Complete the step-by-step run guide in the wiki.
- Assign Dr. Garzon to load the data.
- Code Review and Inspection
- Add comments at critical spots in the code to explain functionality (e.g., purpose of files).
- Avoid making changes that impact the system unless necessary.
- Prepare to assist Dr. Garzon with any crises or urgent issues related to the course.
- Strategize tasks for the last two weeks of November, which are critical for project completion.
- Highlight critical areas in the code with comments.
- Ensure wiki documentation is clear and user-friendly for onboarding new group members.
- Dr. Garzon is responsible for the course and may need urgent support for unforeseen issues.
- Focus on tasks that do not disrupt the system's current functionality.
- Several bugs were closed by the team and code was merged to main
- The process to improve documentation was started
- Professor expressed desire to have code freeze within the next week or two, and that we should reach out to Miguel Garzon to coordinate importing of students for the January semester.
- Professor expressed uncertainty about how project should be maintained in the future. He expressed desire to have a total code review to determine whether he is capable of maintaining the project himself, whether he should have a single student do it, or whether there is still enough work to be done to make another capstone project. He is open to suggestions on this matter.
- Prepare for code review, enhance documentation and clean orphaned code.
- Discuss as a team how best project should be maintained beyond code freeze and winter release.
- Issue identified where students in a group couldn't create another group. Tooltip added to indicate this restriction.
- Page refreshes to immediately reflect updates after changes are made.
- Detect inconsistencies, such as students missing from the student list or appearing incorrectly in groups.
- Implement a feature to acknowledge the logged-in student and confirm their identity on login.
- Add tooltips in other sections for better usability.
- For example, guidance on the group creation form that specifies a section must be created first.
- Implement and rigorously test this feature to move students between groups.
- Resolve inconsistencies that appear when groups are refreshed.
- Deadline: Target completion date is mid-November.
- Issue Tracking: Use the issue tracking system rigorously to log current and future issues.
- Meeting with Professor: Meeting link to be sent; next week’s meeting is tentative.
- Prioritize manual testing to identify and fix issues.
- Keep in touch with the team frequently to stay updated on progress and issues.
- Make the user interface more intuitive for actions like creating sections.
- Provide better guidance when creating a new section to reduce confusion.
- Ensure it is not necessary to assign a professor to create a section.
- Make sections visible on the homepage, including those available for projects.
- Implement logic to remove a group when the last student leaves it.
- Provide the ability to hide empty groups.
- Address the bug where groups are not being added as expected.
- Automatically refresh the group list after changes to reflect the new state.
- Navbar and homepages changed and moved to main.
- Group management function, adding and deleting students, have been added,
- Setup test database with realistic data for the client.
- Find in the code where it gives a notification to students when they are added.
- Client will list test cases and bring it back to us.
- Admin/prof/student navbar changes.
- Tooltips added to prof main page.
- Student view: group + project info added to homepage.
- Push all changes.
- Updated Github actions workflow to version 4 Update artifacts #352
- Started student group info section on student homepage.
- Focus on making the main functionalities working with no bugs. Look for bugs!
- Create test database to be used to find bugs.
- Student's group information should allow different states(no group found, group found, group found but no project,....)
- Complete database cleanup and push to main.
- Refactor APIs to accommodate the new database.
- Tooltips for user guidance.
- Continued work on the prof homepage.
- Issue closed and added.
- Prof homepage changes made.
- Student Homepage: Make group that student is in visible. Make it obvious.
- Issue opened about 'Operational Authentication' error.
- Tooltips for user guidance.
- Complete database cleanup and push to main.
- Refactor APIs to accommodate the new database.
- Continued work on the prof homepage.
- Mockup made for prof homepage. Approved by client.
- Emphasis on functionality over ui/ux changes.
- Database clean up is progressing. Not finished yet.
- Importing Data
- Deleting/adding students
- Third party service set up for health checks
- Database diagram made
- From the database diagram, keys are not being referenced and there are duplicate references.
- Changes need to be made to database.
- Umple can be used to help streamline development.
- Students from different courses may want to form groups. Groups could be a list of students.
- Cleanup database and key relationships.
- Fix bugs relating to students and groups.
- Work on presentation.
- Student search when adding students to groups can
- Progress made with import/export.
- Documentation moved from codebase to wiki.
- Get a better working system by the time the next class starts in the Fall.
- Group IDs should be easy to refer to.
- work on importing data.
- work on deleting/adding students.
- Architecture diagram completed here.
- Dependabot critical warnings addressed.
- ui homepages of all roles updated.
- test each other's work for edge cases.
- when searching for students, add search for student # as well as searching by name.
- work on importing data.
- work on deleting/adding students.
- archive documents in code to wiki.
- change language setting button.
- Export done, import not completed.
- Deleting/adding students to groups started.
- Login page + student homepage ui changes made.
- number/code of group should be automatically assigned.
- deleting/adding students should be more intuitive.
- Polish architecture diagram.
- work on importing data.
- work on deleting/adding students.
- change language setting button.
- add ui changes to homepages of all roles.
- Global import/export button created (not completed).
- Mockups created and presented to client.
- Don't allow profs to import extra columns.
- Test on different operating systems and devices.
- Complete global import/export button.
- Make changes to login page and student homepage.
- Create function to remove students from groups.
- There was an issue with Docker image, where it specified using Python 3.8.18 to create the virtual environment. However, dependencies loaded required Python 3.9, leading to compatability errors. server/Dockerfile was updated to utilize Python 3.9.
- Site encountered issues due to expired keys. Laith intervened by generating a new secret key, which restored the site's functionality.
- Architecture diagram made.
- Include single button to download and import all data easily into Excel with organized tabs.
- Create import/export function.
- Create mockups for UI changes.
- Create function to remove students from groups.
- Investigated node dependencies of client.
- Run system locally.
- Security vulnerability report received from a bug bounty hunter claiming to have found a vulnerability on the software running on port 3000. Server does not expose Node on that port.
- Site down. Must figure out how to get it back up.
- Successfully addressed a critical vulnerability, not yet pushed. Node module JS-YAML patched in version 2.0.10 contains issue, but project utilizes versions higher than 3.2.2.
- UX for students is bad. Should come up with alternative designs.
- Include a student view for professors.
- Make the project easily understandable by adding comments and README files for each directory.
- Ensure setup instructions include all frameworks involved, such as MongoDB, and provide guidance on database usage without prior knowledge.
- Establish the ability to occasionally access and modify current data, either through an empty database or a copy of live data.
- Focus on reducing project risk to very low levels.
- Get site back up.
- Prioritize understanding project setup and improving documentation clarity before addressing bugs.
- Investigate and resolve issues with Pip file installation to ensure smooth project execution.
- Survey created for feedback https://forms.gle/gUCgYxQfs6aJpfBT9.
- Get in contact with previous developer Laith.
- Weekly client meetings scheduled.
- Explored codebase and attempted to run system locally.
- Unusual behaviour with Umple going down due to 504 errors, while Docker configurations running on the same machine remained unaffected. Restarting Academic Teams resolved the issue temporarily
- Unable to run system locally.
- Discussed the need for a domain for hosting the test version of the database.
- Explored options for setting up a mirror and script for updating the test version or granting open access to the host server, with preference for the former due to security concerns.
- Acknowledged the non-normalized database as a prominent issue affecting data consistency. *Discussed potential modifications to the feedback form.
- Node dependencies out of date.
- Recommendations were made to develop architecture diagrams illustrating system functionality and to enhance code comments and README files.
- Develop architecture diagrams and enhance code comments & README files.
- Contact Laith to get system to run locally.
- Investigate node dependencies of client.
- The Academic Teams Management project is open-source and is hosted on Github
- Aims to facilitate the setup of projects, groups, and students for academic courses.
- The project utilizes Docker for production deployment.
The objectives for 2024 include simplifying maintenance for professors and users, ensuring adaptability for use in other courses, and resolving all UX issues by year's end.
- Students need to join groups and express interest in projects.
- Groups need to manage membership and propose projects that meet with certain criteria.
- Professors needs to approve groups and projects, request modifications, and manage course sections and students.
- Interview stakeholders for feedback.
- Seek guidance from previous developers.
- Get familiar with codebase and make simple changes.
- Enhance user documentation and tutorials.
- Schedule weekly client meetings.
- Improve filtering and undo functionalities.
- Clarify button actions and project information visibility.
- Establish a process for database duplication and local hosting.