remotion icon indicating copy to clipboard operation
remotion copied to clipboard

Add Storybook to project example

Open helkaroui opened this issue 2 years ago • 4 comments

Feature Request 🛍️

I would like to add Stroybook to project example by default. Asking for your opinion before making a PR.

Use Case

  • Demonstrate static and animated assets
  • Enlist sequences and compositions
  • Be able to test customization on the fly for elements without adding them to the final composition

Here is a working example of the suggested feature : remotion_storybook(1)

helkaroui avatar May 06 '22 10:05 helkaroui

Yes that'd be sick 🤩 🙌 Thanks a lot for offering this!

JonnyBurger avatar May 06 '22 13:05 JonnyBurger

Where would you plan to add this? in the example, or player-example folder, or a new package? or a separate storybook example repo?

JonnyBurger avatar May 06 '22 13:05 JonnyBurger

My plan is to add storybook integration as follow : Project example https://github.com/remotion-dev/template-helloworld

  • Add stories to all components and compositions
  • Add yarn commands to start and build storybook
  • Update Readme

Core project

  • Update docs with commands and screenshots : https://github.com/remotion-dev/remotion/tree/main/packages/docs

What do you think ?

helkaroui avatar May 07 '22 09:05 helkaroui

Hi Hamza!

I would prefer if we forked the Hello World template and made a new template that has Storybook preinstalled. When creating a new project, the user can pick from multiple templates, and we would add it to the list.

The reason I prefer this is that the template is the default and most people don't need Storybook when making a new video, since Remotion also has a sidebar that allows to switch between different compositions.

Nonetheless, I find it nice if the user can choose to scaffold their project with Storybook, so I'd be in support of documenting and promoting this template.

JonnyBurger avatar May 08 '22 16:05 JonnyBurger

In v4, we will have more Storybook-like features ourselves, where you can also test out different combinations of props in the sidebar. Therefore I think having a Storybook integration in addition to this would not make much sense and does not seem to have been gaining interest over the past year.

Because of this, no plans exist to integrate with Storybook.

image

JonnyBurger avatar Mar 30 '23 08:03 JonnyBurger