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

Refactor(Client): pdf-bullets to TypeScript MVP #46

Open
1 task
justinthelaw opened this issue Jun 29, 2023 · 2 comments · Fixed by #174 or #221
Open
1 task

Refactor(Client): pdf-bullets to TypeScript MVP #46

justinthelaw opened this issue Jun 29, 2023 · 2 comments · Fixed by #174 or #221
Assignees
Labels
feature New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@justinthelaw
Copy link
Owner

justinthelaw commented Jun 29, 2023

Is your feature request related to a problem? Please describe.
This is a refactor of pdf-bullets to TypeScript with the existing styling and components. The purpose of this is to provide a springboard to further improvements upon the UI/UX, and the introduction of more organized, maintainable TypeScript code.

Describe the solution you'd like

Feel free to break down the below into multiple sub-steps based on the building blocks of the pdf-bullets functional areas.

  • Refactor pdf-bullets into TypeScript, with minimal functional changes and full-coverage unit tests. Directory structure and file organization are up to the developer(s).

Describe alternatives you've considered
Re-creating everything pdf-bullets did from scratch is not prudent. The MVP of pdf-bullet functionality is the first step towards the Bullet Forge feature, which is where the real magic starts happening!

Additional context
In the README.md, the introductory sections talk about where you can find a copy of the live pdf-bullets web application, as well as the minimum, non-AI/ML features pdf-bullets offered to its users.

Additionally, you can find the original legacy code within the archive/ directory of the repository. As the developer(s) go, delete the archive folder contents.

@justinthelaw justinthelaw converted this from a draft issue Jun 29, 2023
@justinthelaw justinthelaw added good first issue Good for newcomers feature New feature or request help wanted Extra attention is needed and removed help wanted Extra attention is needed labels Jun 29, 2023
@justinthelaw
Copy link
Owner Author

Important note: Tests were not written for the original pdf-bullets. We should focus on testing and implementing the basic bullet formatting functions before moving on to other components. Additionally, we should refactor as we go if readability or other quality aspects of the code are lacking.

@ananaso
Copy link
Collaborator

ananaso commented Jul 7, 2023

Seems that jest types not always being recognized is a known issue with VSCode: microsoft/TypeScript-Node-Starter#196 (comment). Can confirm that opening, for example, just the client folder rather than the parent smarter-bullets folder makes jest and VSCode interact just fine.

Edit: Solved by adding @types/jest and @testing-library/jest-dom to the root package.json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: 🏗 In Progress
3 participants