Northeastern-Electric-Racing / Northeastern-Electric-Racing/FinishLine

[Gantt Chart] - 1.2.1 Audit frontend filter and design new API

Open
#4,466 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
36
Forks
9
Avg merge
4d 21h
Merged PRs (30d)
11

Description

Description

Currently, filtering on the Gantt chat is entirely on the frontend. All project/work package/task data is loaded up front, and filters (team, car, etc.) just hide/show elements client-side. This is part of why initial page load is so slow.
This ticket has two parts: document how filtering currently works so we know exactly what needs replacing, and design the shape of the new backend API that only returns data matching active filters, so #4467 has a clearer spec.
Note: no code changes for this ticket! Investigation and design only

Acceptance Criteria
  • Written documentation (a doc, or a detailed comment on this ticket) listing every filter currently available
  • For each filter, write how it's currently implemented: what data is fetched, and what frontend logic hides/shows elements based on the filter
  • Proposed API design
    -- What endpoint(s) the frontend will call when a filter changes (i.e. one endpoint with query params vs. separate endpoints per filter type)
    -- What query parameters it accepts
    -- What shape of data it returns (which fields, whether it's the same shape as current frontend data or different)
    -- How multiple simultaneous filters combine
Proposed Solution
  • Find filters in frontend code
  • Trace how filter selection currently works
  • List all filter types
  • Decide on one endpoint vs multiple, how filter values are sent, whether multiple values can be selected for a filer and how that's represented, what happens when a filter matches nothing, etc.
Mocks

No response

Contributor guide

No contributing guide indexed for this repository

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 locating the Gantt Chart frontend filter implementation and tracing how filter selections fetch data and hide or show elements. Document every available filter and its current data flow, then record the proposed endpoint, parameters, response shape, and combined-filter behavior; completion is the documented investigation and API design with no code changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
api, documentation, frontend
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.