bcgov / NRPTI

Natural Resources Public Transparency Initiative
Apache License 2.0
5 stars 15 forks source link

Migrate from Javascript to Typescript for NRPTI API #1015

Open LolandaE opened 1 year ago

LolandaE commented 1 year ago

Describe the task Moving from javascript to typescript would strongly improve the developers experience in working on the app, and would make it easier for new devs to understand how the API works.

Purpose Improve maintainability and developer experience, addresses vulnerabilities in NRPTI API, adds consistency, reduces likelihood of introducing new bugs

Acceptance Criteria

Additional context

pinkyandthekane commented 1 year ago

Biggest thing we can do is migrate from JavaScript to TypeScript where possible, ensuring the application code is as strictly typed as possible. I'm encountering numerous bugs in the system that are being introduced as a result of using JavaScript without any type guarding, something you'd struggle to find in a strictly typed system. I wonder how we could start small with this?

sanjaytkbabu commented 1 year ago
  1. Improvement to current CI/CD pipeline to facilitate DEV deployment without merging to master.
  2. Make TEST and PROD deployment happen using GitHub actions.
jakemorr commented 6 months ago

something we want to consider doing over time as we work on NRPTI is transition code to Typescript as we do work. not a big bang refactoring.