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

Configure Storybook for Orderbook Component Testing #1346

Open
wants to merge 2 commits into
base: internal
Choose a base branch
from

Conversation

minikas
Copy link
Member

@minikas minikas commented Jul 14, 2024

Description

This pull request sets up Storybook for testing Orderbook components and pages.

Changes Made:

  • feat: Installed and configured Storybook
  • feat: Added initial story
  • fix: tailwind Css dependency upgraded
  • fix: postcss dependency upgraded
  • fix: autoprefixer dependency upgraded

Screenshots / Screencasts

Screenshot 2024-07-14 at 16 37 23

Checklist

  • Included link to corresponding Polkadex Orderbook Frontend Issue.
  • I have tested these changes thoroughly.
  • I have requested a review from at least one other contributor.

Close: #1345

Copy link

coderabbitai bot commented Jul 14, 2024

Walkthrough

The recent updates introduce Storybook configuration for the hestia app, enabling component testing for the Orderbook feature. Key enhancements include adding support for story files, configuring essential addons, and setting up a custom theme. These changes aim to improve the robustness and standardization of Orderbook components through a dedicated testing environment.

Changes

Files Summary
apps/hestia/.gitignore Added exclusion for storybook.log.
apps/hestia/.storybook/main.ts Configured Storybook with new story paths, essential addons, and framework settings.
apps/hestia/.storybook/manager.ts, preview.tsx Introduced logic for Storybook manager and preview configurations, enhancing the development experience.
apps/hestia/.storybook/theme.ts Added a custom theme with brand-specific properties for Storybook UI.
apps/hestia/src/components/accessDenied/template.stories.ts Added a story for the Access Denied template component to facilitate testing and demonstration.

Sequence Diagram(s)

No sequence diagrams are generated as the changes are predominantly configuration-based and do not modify control flow.

Assessment against linked issues

Objective Addressed Explanation
Configure Storybook for Orderbook Component Testing (#1345)

Poem

In the land of code so bright and fair,
Storybook now handles components with care.
From Access Denied to themes so sweet,
Bugs retreat, and tests are neat.
With every story we now unfold,
The Orderbook shines, vibrant and bold.
🐰✨📖


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@minikas minikas linked an issue Jul 14, 2024 that may be closed by this pull request
Copy link

netlify bot commented Jul 14, 2024

Deploy Preview for stupendous-valkyrie-505e4a failed. Why did it fail? →

Name Link
🔨 Latest commit 5dd1636
🔍 Latest deploy log https://app.netlify.com/sites/stupendous-valkyrie-505e4a/deploys/66942f408c5ba50008bc61ea

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1b2e66b and 75dd16d.

Files ignored due to path filters (3)
  • apps/hestia/package.json is excluded by !**/*.json
  • apps/hestia/public/logo.svg is excluded by !**/*.svg, !**/*.svg
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock, !**/*.lock
Files selected for processing (6)
  • apps/hestia/.gitignore (1 hunks)
  • apps/hestia/.storybook/main.ts (1 hunks)
  • apps/hestia/.storybook/manager.ts (1 hunks)
  • apps/hestia/.storybook/preview.tsx (1 hunks)
  • apps/hestia/.storybook/theme.ts (1 hunks)
  • apps/hestia/src/components/accessDenied/template.stories.ts (1 hunks)
Files skipped from review due to trivial changes (3)
  • apps/hestia/.gitignore
  • apps/hestia/.storybook/manager.ts
  • apps/hestia/src/components/accessDenied/template.stories.ts
Additional comments not posted (9)
apps/hestia/.storybook/theme.ts (3)

1-3: Verify necessity of @ts-ignore.

The @ts-ignore comment might be suppressing a TypeScript error. Ensure that this is necessary and consider resolving the underlying issue if possible.


1-4: LGTM!

The import statements are correct and necessary.


5-23: LGTM!

The theme configuration is correctly set up with appropriate properties for colors, backgrounds, and brand details.

apps/hestia/.storybook/preview.tsx (3)

1-5: LGTM!

The import statements are correct and necessary.


7-10: LGTM!

The font configuration is correctly set up with appropriate weights and subsets.


12-31: LGTM!

The preview configuration is correctly set up with appropriate parameters for actions and controls, and a decorator for applying the font.

apps/hestia/.storybook/main.ts (3)

1-4: LGTM!

The import statements are correct and necessary.


5-11: LGTM!

The utility function getAbsolutePath is correctly implemented and follows best practices.


12-32: LGTM!

The Storybook configuration is correctly set up with appropriate stories, addons, framework, and static directories.

@minikas minikas changed the title Configure Storybook for Orderbook Component Testing #1345 Configure Storybook for Orderbook Component Testing Jul 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Configure Storybook for Orderbook Component Testing
1 participant