search

LibrePhotos / librephotos

A self-hosted open source photo management service. This is the repository of the backend.
MIT License
7.01k stars 309 forks source link

storybook for the front-end #635

Open polaroidkidd opened 2 years ago

polaroidkidd commented 2 years ago

Describe the enhancement you'd like Add storybook the the development process.

Describe why this will benefit the LibrePhotos Changing inputs and behaviour of components can be done in an isolated environment while remaining sure that all consumers adhere to the components' api

Additional context N/A

sickelap commented 2 years ago

I like the idea to have a storybook. @polaroidkidd are you planning to pick this up anytime soon?

polaroidkidd commented 2 years ago

anytime soon?

Might start giving it a go this weekend. I can start with a couple of components to serve as a template (or a "how-not-to-do-it" reference since I've never worked with storybook) and then others can contribute to the book. If we want to actively maintain it, then new components should always include a story-book, right?

sickelap commented 2 years ago

Yes, new components should contain a storybook so we have a clear example of how to use it. For me, it's difficult to see us adding a lot of new components right now. I guess at the beginning we would be refactoring existing ones.

polaroidkidd commented 2 years ago

should we maybe add refactored components to the book too as part of the refactoring?

sickelap commented 2 years ago

sure. Just pick a component that is definitely used in multiple places, like Tile