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

add storybook basic setup #1

Merged
merged 3 commits into from
Apr 1, 2024
Merged

add storybook basic setup #1

merged 3 commits into from
Apr 1, 2024

Conversation

Diogomartf
Copy link
Contributor

This is a basic setup just to get us started. We can use storybook to quickly build and test a component before publishing it.
We can also use it for docs.

image

I added an example of our Button component.

image image

package.json Outdated Show resolved Hide resolved

// More on default export: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
export default {
title: "Swapr-ui/Button",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small think to bear in mind in future:
This title path groups the components, so if we keep pushing Swapr-ui/Button, there will be a big Swapr-ui folder in Storybook

IMHO this doesn't make much sense as we're in this repo. I'd use this grouping feature only if we have component groups either by functionality or design (for example atoms, molecules, etc).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense, but for now, It's just to show case, so I'll keep it like it is. But I think you have experience in that and you can lead the storybook to put it neat. 🙌

Co-authored-by: Rorry <lil.rorry@gmail.com>
Copy link

vercel bot commented Apr 1, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
swapr-ui-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Apr 1, 2024 4:29pm

@Diogomartf Diogomartf merged commit 4a14c18 into main Apr 1, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants