sogrim/technion-sogrim

Get your degree status in the best possible way 🤓

technion-sogrim's Issues

New APIs for the Catalog Marketplace feature

Catalogs

• GET catalogs details (query for market place) - query params: [cursor?, filter?] filter - faculty, year
• GET catalog by ID (FULL)
• POST catalog -> validations

Likes

• POST like (true/false)

Add support for irrelevant courses

• Add an option for the student to remove courses. @NissanOhana
• Ignore courses the student removed in the core function. @liadaram1

Handle edge cases in specialization groups

When a course should belong does not necessarily to the specialization group in which it first appears.
There are 2 ways to solve this:

1. Add support in modified specific specialization groups for courses.
   Then. the user would tag it manually.
2. Implement exhaustive search (or think of a more sophisticated search) in the core side.

Identify special courses

Check with the coordinators how to identify:

• Malag courses
• Sport courses
• Free Choice courses

Edited:
After some investigation probably the solution would be:
Malag - All courses with the prefix 32 and 2 points, or one of the courses in a closed list (for now the list is 214120).
Sport - All courses with the prefix 394 and 1 point, or "NIvharot Sport (394902).

Remove duplicate files

We have 2 (almost) identical files "CourseValidator.ts" and "course-validator.ts".
We should remove "course-validator.ts", and let every component to use the functions in "CourseValidator.ts".
In addition we need to locate the file under SemesterPage hierarchy.

Edit: Same for "Tabs.tsx" and "PageTabs.tsx"

Possible synchronization issue between B.O. app and Students app

We should consider this possible scenario and decide how to solve it:

1. Some users use the Student app with catalog A and their UserDetails are saved to the DB.
2. One of the coordinators (רכזות) updates catalog A and changes its demands and rules.
3. All of the users who use catalog A now have invalid details.

Fix UI/UX issues in student app

• Demands tab

Refactor the way we handle modified courses in core

What we are doing now is to add the modified courses to the course list of the bank.
However, if the user adds manually פיסיקה 1 for example, it doesn't recognize it as a replacement for פיסיקה 1מ.
To solve this, we added a function which remove duplicate courses, but we still don't have the small comment on פיסיקה 1 which is a replacement for פיסיקה 1מ.
There is a robust way to fix it by not adding it to the list and just look the bank type of the course itself.

Semi-automation process for adding catalog

• Add strong validations on new catalogs for the flow.
• Add semi automation flow to add catalogs easily. The most difficult parts are:
  • Handle course_to_bank field.
  • Handle specialization_groups rule.

• Should replace the market place solution

Handle edge cases in core algorithm

• Students with common replacements (חדוא במקום אינפי)
• Students with special (approved) replacements ( פיסיקה 1 במקום 1מ)
• Catalog-specific replacements

Clean the specialization groups code

The code of specialization groups algorithm is very complicated.
We should make the code cleaner, more readable, and add comments in every non trivial part of the code.

Make UI sketch with API

Add ALL courses to DB

Currently we have about 400 courses out of 1300 11000~

Add end-to-end tests

Add READMEs and extensive documentation

• Client
  • README
  • Docs
• Server
  • REAMDE
  • Docs
• Core
  • Docs

Add a way for the user to update exemptions and credits

After the user inserts his grade sheet, the exemptions and credits are calculated automatically and added to "semester 0".
Thus, the user can't update them even if there are some mistakes in the calculations.

Reduce code duplication in core tests

Semester tabs bug on windows/chrome

When having more than 8-9 semesters and the scrolling arrows appear the tabs component breaks.
For now it seems that this only happens on Windows + Chrome

Display course number when course name is empty

Under requirements the course name is displayed by default.
However, course name can be empty.
Thus, when it does the course number should be displayed instead, otherwise only the credit is displayed and it is not clear what course is it.

Revert irrelevant courses

After the student marks a course as irrelevant he doesn't have any way to revert it besides reset the account.

Add `CatalogDetails` and `CatalogSocial` to `Catalog`

• Update all the relevant places in BE and FE code
• Update debug DB

Deploy client app

• Add a CI job for deploying the client

Migrate from heroku to render

Consider creating a new sub-store for the DegreeMainStatus

The logic in DegreeMainStatus is very loaded.
We should think about creating a new sub-store for this logic.

UI - Marketplace Component

• Marketplace details component
• Catalog viewer component

Support both ways of parsing grades (from UG & from PDF)

• #14
  • Parse grades imported from PDF
  • Parse grades imported from UG

Create a seperate branch for development, and make the main only for version releases

• Create development branch
• Add more CI actions depending on the profile, dev or release.

Landing page (anonymous)

Make A landing page. fill this white space when the user first encounters the app:

inspiration - https://plus.excalidraw.com/

FYI, @liadaram1 @benny-n

Switch to faculty hierarchy

After extending the system to more faculties we should add another layer in the hierarchy.

• Extract common-replacements to faculty layer. The common replacements should be identical across faculty catalogs.

Add client-side unit tests (with jest)

Course number should be a string

• @benny-n change course number in DB from number to string
• @benny-n change course number in server handlers from number to string
• @liadaram1 change course number in core functions from number to string

Add a full flow test for computer engineering itinerary

B.O. server API

Separate the errors when adding a new course

When adding a new course to a specific semester with a course id which already exists, or adding a course with invalid course id, we get a general error for both cases.
We should separate those cases so the error would be more informative to the user.

Validations for POST Catalog

• Make sure the course dependencies graph is acyclic
• Resolve cases of duplicate courses

domain ?

Support "in progress" courses

• add "settings" to User resource
  • add 'modified' flag to settings (cancelled)
  • add compute_in_progress flag as a setting
  • update db
• create PUT /student/settings
• before degree-status compute, check compute_in_progress flag and change courses statuses if needed.
• add toggle button UI to client
• change default course_status from 'complete' to 'in-progress'

Location of exporting degree status to CSV logic - fe / be?

maybe we need to think about the "location" of this logic - fe / be?
@liadaram1 @benny-n wdyt?

Originally posted by @NissanOhana in #120 (comment)

Fix packages typo in repository

Demo & QA fixing Plan for 1.0.0 version

Core function side: @liadaram1

• Add a full flow test for 3 years computer science itinerary.
• Add small tests for each component of the core function independently.
• Add a full flow test for software engineering itinerary.
• messages
• #68
• adding 2-3 new catalogs (with the BO app)
• מעבר נקודות info icon & change title #85
• types fe & be #77
• adding loading state to banner cards when we "סגור את התואר"
• send feedback form (footer) #72
• אנחנו לא הטכניון disclaimer #86
• table - min width #94
• table - grade arrows when editing #94
• #75
• minimal redme.md file
• #84
• skip import courses step, and manually add all your courses #91
• inform students about בחירה חופשית for any course that isn't in the DB + FAQ about it #83
• #78
• card for null semester
• BLOCK FOR MOBILE!!!
• bug: can't add new semester to user without semesters #90

React memo & performance optimizations

Vision (backlog)

• Any user can login - and make his own catalog. #
• CANCELLED User details array - users have a number of possibilities to check different catalogs & planning.
• Responsive for mobile.
• Better editing table experience (Reut)
• More Faculties!!!
• stats page
• guest flow (with localstorage / dummy user?)
• intro flow

Improve 'welcome' & 'change catalog' flows

Error handling

• Handle 401s after users are idle for a long time - TEMPORARY SOLUTION - #103 Handled robustly with #168
• Better error handling in server side - #123
• Error fallback page - #168

Calculate and display the user's GPA

• Display the user's GPA in the client side @NissanOhana

UI - Catalog Wizard

• Stepper
• "From Blank"
• "From Duplicate"

Stop supporting exporting grades from UG

• #41 Remove the UG grades parser (should the server return a 400 if we still get ug grades?) @benny-n
• Change the UI in ExportGilion.tsx. The user should understand that grades from UG are not supported @NissanOhana
• Change some variable names with 'UG' in them @benny-n @NissanOhana

Fix list of chain's courses

After some feedback from students, they prefer the chain will display the whole courses from the bank and not only the courses for the specific chain.

Communication between client and server - update user details

• Backend
• Frontend

Add a full flow test for specialization groups

• Upload a catalog for computer engineering itinerary.
• Upload a grade sheet of student who takes this itinerary and check the whole flow.