search

paranext / paranext-core

Electron client, extension host, and C# library for Paranext
https://paranext.github.io/paranext-core/
MIT License
14 stars 2 forks source link

Added platform-bible-react preview page, revised readmes #870

Closed tjcouch-sil closed 1 month ago

tjcouch-sil commented 1 month ago

Resolves #865

This change is Reviewable

Sebastian-ubs commented 1 month ago

Hi @tjcouch-sil, please help me understand: is this another way of serving components form a standalone dev server? How does this compare to running components in Storybook?

Sebastian-ubs commented 1 month ago

@rolfheij @jolierabideau could you give me any hints, while TJ is out?

rolfheij-sil commented 1 month ago

You tagged my private Github account. Not a bad way to get my attention on my day off 🤣

We created this small preview page to make the development of components in platform-bible-react easier. Before the process would be: Make changes to the code of your component, (re)build the entire platform-bible-react library, run Storybook or Platform.Bible from main. (Re)building the library and spinning up Platform.Bible would take up to two minutes where you had to sit and wait. This was very time consuming, especially when you made lots of small changes/tweaks (like adding/removing Tailwind CSS directives).

This small preview page allows you to see the changes in your components live. It kinda serves the same purpose as Storybook would, but since it's a fully functional React component, it also allows you to do some more advanced operations on it, like using (React) hooks and wrapping in divs or other components.