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

Integrate Storybook in the project #26

Closed
zivnadel opened this issue Apr 5, 2023 · 8 comments
Closed

Integrate Storybook in the project #26

zivnadel opened this issue Apr 5, 2023 · 8 comments
Assignees
Labels
enhancement New feature or request

Comments

@zivnadel
Copy link
Contributor

zivnadel commented Apr 5, 2023

I suggest we add Storybook to the project. Storybook is a user interface development environment that allows us to build, test, and showcase our UI components in an isolated, reusable environment.
It will significantly improve collaboration, and will help keeping unified design language across the entire app.
I started testing it locally, and so far, it seems suitable for this project.

@zivnadel zivnadel added the enhancement New feature or request label Apr 5, 2023
@zivnadel
Copy link
Contributor Author

@yonatanmgr What do you think?

@yonatanmgr
Copy link
Owner

That's a good idea, though I do have a question - does it require us to copy all of our components manually to Storybook?

@zivnadel
Copy link
Contributor Author

zivnadel commented Apr 18, 2023

That's a good idea, though I do have a question - does it require us to copy all of our components manually to Storybook?

Yes. We need to create component.stories.tsx file for each component and pass props

@ErezBiren
Copy link
Collaborator

ErezBiren commented Apr 18, 2023

I would put there only the common reusable components.
It doesn't make sense to put there FilesSidebar , but we can put the ConfirmModal for example.

In addition, we can put all the stories in one file, although it's a best practice to separate to file for each component.

@yonatanmgr
Copy link
Owner

Sounds good! How do we start with this? If any of you wants this I'll assign you, if not I'll do it!

@zivnadel
Copy link
Contributor Author

@yonatanmgr I can do it.

@yonatanmgr
Copy link
Owner

@zivnadel Assigning you!

@zivnadel
Copy link
Contributor Author

According to the developers of Storybook, electron is not supported, and there are no plans to add support in the future as stated in storybookjs/storybook#1435. Although I was able to successfully initialize Storybook in the project, I'm concerned that it may not work seamlessly with electron's core. Therefore, I have decided to not proceed with it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants