Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate JSON config to a TS config #39

Open
2 tasks
alcpereira opened this issue Sep 17, 2024 · 1 comment
Open
2 tasks

Migrate JSON config to a TS config #39

alcpereira opened this issue Sep 17, 2024 · 1 comment

Comments

@alcpereira
Copy link
Owner

To fill all the data of the CV, we are relying on a JSON file that is imported into the React project.
While this was an easy solution to begin with, it lacks in type safety (both on the JSON itself, and in the app) and will not scale well.

This is a step forward into having a full client side PDF Generator (storing the data in LocalStorage, and using client PDF printing), and we will reuse the types to do runtime type checking on the extracted data from LocalStorage (this is indeed a client input, it must always be checked).

AC

  • data.json does not exist anymore and everything is in a single TypeScript config file (fully type safe)
  • Documentation regarding the fields (through JSDoc on the types and/or Markdown)
@MFRS
Copy link

MFRS commented Sep 19, 2024

Will look into this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants