Northeastern-Electric-Racing / Northeastern-Electric-Racing/FinishLine
[Executive Summary] - getBudgetSummary endpoint
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 36
- Forks
- 9
- Avg merge
- 4d 21h
- Merged PRs (30d)
- 11
Description
Description
We need a getBudgetSummary endpoint to get the information to display the donut chart (show in image below). This can go in exec-summaries.services.ts , exec-summaries.controller.ts, etc.
Acceptance Criteria
- transformer for BudgetSummary
- takes in an executiveSummaryId and returns a BudgetSummary
Proposed Solution
- new endpoint in exec-summaries.services.ts
- reuse the existing logic for division budget aggregation that is found in statistics.utils.ts, but narrow it down to the season's date range, and optionally by competition (FSAE/FHE).
Mocks
No response
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing division budget aggregation in statistics.utils.ts, then inspect exec-summaries.services.ts and exec-summaries.controller.ts. Add the BudgetSummary transformer and endpoint entry point described in the issue, accepting an executiveSummaryId and applying the season date range with optional FSAE/FHE competition filtering. Done means the endpoint returns the expected BudgetSummary for the donut chart.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100