nusmodifications / nusmodifications/nusmods

RFC: Advanced timetable export interface

Open
#1,003 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Our current export system is quite powerful because it uses a full Chromium instance to render the website. This means that it can actually support quite a lot more features than what we have now. This may be useful to expose to users since a common NUSMods use case is to export the timetable as image for printing or as a wallpaper.

Proposal:

Using a modal to contain additional options, we can offer users the ability to export their timetable in arbitrary size, optionally with padding around the edge. Implementation should be relatively easy -

  • Add support for additional options to the export server
  • Decide on how the additional options should be sent over (probably just added to the object)
  • Implement the modal on www, with intelligent defaults to select the user's current screen size, and options for common screen / paper sizes

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

Start by tracing the current export flow through the export server and the www interface. Define how arbitrary dimensions, padding, screen sizes, and paper sizes are represented and passed, then confirm the modal uses sensible defaults and that the server produces the requested timetable output.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react, typescript
Domain
full-stack
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.