search

Sanchitbajaj02 / palettegram

A social media app to get designs and color palettes for designers by designer.
https://palettegram.vercel.app
MIT License
57 stars 97 forks source link

feat: integrate Shepherd tour with custom styling #348

Closed sneha-4-22 closed 1 month ago

sneha-4-22 commented 1 month ago

Related Issue

fixes: #347

Description

https://github.com/Sanchitbajaj02/palettegram/assets/112711068/35666cfe-d206-4da0-a578-232f269f42e0

Summary by CodeRabbit

vercel[bot] commented 1 month ago

@sneha-4-22 is attempting to deploy a commit to the Sanchit Bajaj's projects Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes introduce a guided tour feature to the platform using Shepherd.js. This enhancement includes the addition of a startTour function to initialize the tour, a "Start Tour" button in the navbar to trigger it, and custom styling for the tour elements to ensure they align with the platform's theme. These modifications aim to provide users with an interactive and informative walkthrough of the platform's functionalities.

Changes

File Path Change Summary
src/components/core/navbar/index.tsx Added startTour function and "Start Tour" button to initiate a guided tour using Shepherd.js.
src/components/core/themeButton/index.tsx Added spaces before className attribute values in JSX buttons for improved formatting.
src/components/core/utils/startTour.tsx Introduced startTour function to initialize a guided tour with Shepherd.js.
src/components/core/utils/styles.css Added styling rules for Shepherd.js elements using Tailwind CSS classes to match the platform's theme.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant Navbar
    participant Shepherd
    User->>Navbar: Click "Start Tour" button
    Navbar->>Shepherd: Call startTour function
    Shepherd->>User: Display guided tour steps

Assessment against linked issues

Objective Addressed Explanation
Integrate Shepherd.js for creating guided tours (#347) ✅
Ensure the tour initializes correctly when the "Start Tour" button is clicked (#347) ✅
Customize the appearance of the tour elements to align with the website's theme (#347) ✅
Smaller tour box size with reduced padding and adjusted font sizes (#347) ✅
Custom border, background, and text colors to match the site design (#347) ✅
Smooth transitions and hover effects (#347) ✅

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.