Skip to content
This repository has been archived by the owner on Nov 27, 2023. It is now read-only.

Refactor: Refactor most of the code base #19

Open
Guz013 opened this issue Jul 3, 2023 · 0 comments
Open

Refactor: Refactor most of the code base #19

Guz013 opened this issue Jul 3, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@Guz013
Copy link
Member

Guz013 commented Jul 3, 2023

Now, with knowledge of the project structure, it would be good to refactor most of it with some improvements:

  • Refactor @marknow/banners

    • Create the SVGs/Banners manually and just replace the placeholders (%%TITLE%%, %%SUBTITLE%%, etc.). This would remove the dependency on satori, making the creation faster and simpler. Also, would pretty much create the natural support for custom banners

    • Create a better API and helper functions.

      • Probably have the main function/constructor as a class instead of an async function?
      • Have a helper function for dealing with Iconify icon collections JSON's. So the collections themselves aren't a dependency, but removes the necessity of creating manually logic for it and/or the use of fetching every single icon.
  • Refactor/Recreate the rest API and web editor.

    • Probably in the API itself, it wouldn't have breaking chances. But because in the current state, it is mostly an MVP, it would be better to recreate how it handles state management and UX.
    • Make the UI responsive.
    • Prepare codebase for future features (such as a possible Markdown editor and shields/badges)
@Guz013 Guz013 self-assigned this Jul 3, 2023
@Guz013 Guz013 added the enhancement New feature or request label Jul 3, 2023
@Guz013 Guz013 pinned this issue Jul 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant