ZINC-FYP-2022-23 / console

ZINC UI for teaching assistants
1 stars 0 forks source link

Make GUI Assignment Builder a plug-and-play component #26

Closed AnsonH closed 1 year ago

AnsonH commented 1 year ago

Description

Kris prefers that our GUI Assignment Builder code to behave like a "node module", so that when it is migrated to a new repo, he can simply use a single component (e.g. <GuiAssignmentBuilder />) and it works out of the box.

In other words, we should expose a single component such that all the states and contexts are internal within that component. We should investigate how to make our feature a more plug-and-play manner.

Notes

Currently all styling are performed using Tailwind. However, Kris is reluctant to use Tailwind and he prefers using component libraries (e.g. Mantine, Material UI). We should ask if it's OK for the component to use Tailwind internally, as the consumer of this component may require (not sure, need research) extra set-up.

AnsonH commented 1 year ago

Notes from 2023-01-12 meeting:

Refactoring this system into a plug-and-play package is NOT a must. We should consider the following factors:

AnsonH commented 1 year ago

Marking this as "wontfix" because the GUI Assignment Builder will have a certain level of coupling with the existing console website:

Therefore, the marginal benefit of making this subsystem a plug-and-play component is low. Instead, we can write documentation on how this system is coupled with the existing system and explain its file structure.