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

3 - Storybook Setup #8

Merged
merged 14 commits into from Feb 28, 2023
Merged

Conversation

MellyGray
Copy link
Contributor

@MellyGray MellyGray commented Feb 24, 2023

What this PR does / why we need it:

This PR configures Storybook to be used in the SPA development. Storybooks allows to render each component individually to develop them without being attached to a page, this allows a better development of the components since they are actually uncoupled from other components or pages.

Storybook also allows an easy setup for accessibility tests with the a11y addon.

For Storybook example purposes the HelloDataverse.tsx component has been edited to have a Header.tsx component. This Header will be edited in the future to really match the Dataverse design but for the moment it serves as an example of how to integrate Storybook in the UI development workflow.

Which issue(s) this PR closes:

Closes #3

Special notes for your reviewer:

Changes

  • Storybook added to the project
  • Headers.tsx and Button.tsx components added to serve as examples for the Storybook use. They may be reused for the SPA real pages in the future
  • Header, Button and HelloDataverse stories added to the Storybook to test the different states of the components such as Log in and Log out
  • HelloDataverse.tsx component edited to have the Header.tsx component, just for example purposes
  • test Github workflow edited to run also the Storybook tests, to check if Storybook is still working and to run the accessibility tests

Disclaimer about this console error

You'll see this error message in the console when accessing Storybook.

image

Stoybook is working on it but still there is no solution for the message, however it shouldn't affect Storybook functionalities

Suggestions on how to test this:

Install node v19 and npm v9.

Run npm install

Run npm run storybook and go to http://localhost:6006 to see the Storybook page

Run npm run test-storybook to run Storybook tests

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

Hello Dataverse with Header screen If you cannot access the screen please contact melinahernandez@theagilemonkeys.com

Captura de pantalla 2023-02-24 a las 16 24 26

Is there a release notes update needed for this change?:

Storybook added to the project

Additional documentation:

Dataverse - SPA Development Strategy

@MellyGray MellyGray marked this pull request as ready for review February 24, 2023 12:18
@rtreacy rtreacy self-assigned this Feb 27, 2023
@GPortas GPortas added this to Ready for Review ⏩ in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) via automation Feb 27, 2023
@rtreacy rtreacy moved this from Ready for Review ⏩ to Review 🔎 in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Feb 28, 2023
Copy link

@rtreacy rtreacy left a comment

Choose a reason for hiding this comment

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

Looks good

IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from Review 🔎 to Ready for QA ⏩ Feb 28, 2023
@rtreacy rtreacy removed their assignment Feb 28, 2023
@kcondon kcondon self-assigned this Feb 28, 2023
@kcondon kcondon merged commit 0c6b1c1 into feature/react-spa-skeleton Feb 28, 2023
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from QA ✅ to Done 🚀 Feb 28, 2023
@kcondon kcondon deleted the feature/storybook-setup branch February 28, 2023 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants