nusmodifications / nusmodifications/nusmods

Show vacancy information during module registration

Open
#3,335 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature request pending requirements
Dominant language
JavaScript
Stars
689
Forks
364
Avg merge
7h 5m
Merged PRs (30d)
14

Description

Problem description

The official module vacancy report provided by NUS is not real-time and not easily parsable programmatically. It is tiring to jump between NUSMods and EduRec merely to find out if some module still has a vacancy. To make things worse, there is no consistent way to query the vacancy information of a module from EduRec (select modules during rounds, appeal afterwards, and impossible to see it when one already runs out of available workload).

Possible solution

Display the vacancy information on NUSMods alongside other information during ModReg periods. Also, provide an API endpoint for that as well. As an enhancement, this might also be added as a search criterion for filtering out modules without vacancy.

Alternatives

If NUS is reluctant to grant access to its internal real-time data, it might also be possible to parse the table in vacancy report using tools such as tabula.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no repository files or tests. Start by reviewing how NUSMods obtains module data and whether EduRec access or parsing the linked vacancy-report PDF with Tabula is feasible; done means showing vacancy information during ModReg periods and exposing it through an API endpoint.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react, typescript
Domain
api, backend, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.