Polkadex-Substrate / Polkadex-Orderbook-Frontend

https://orderbook.polkadex.trade
3 stars 3 forks source link

Configure Storybook for Orderbook Component Testing #1346

Open minikas opened 1 month ago

minikas commented 1 month ago

Description

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

Changes Made:

Screenshots / Screencasts

Screenshot 2024-07-14 at 16 37 23

Checklist

Close: https://github.com/Polkadex-Substrate/Polkadex-Orderbook-Frontend/issues/1345

coderabbitai[bot] commented 1 month ago

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
netlify[bot] commented 1 month ago

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

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