search

shravan20 / github-readme-quotes

Dynamic quote generator for your GitHub readmes | Give a poetic touch to readmes
https://github-readme-quotes-returns.vercel.app/
MIT License
265 stars 144 forks source link

feat: Quote of the day Widget Feature (static quote) #308

Closed 4nshuman closed 3 weeks ago

4nshuman commented 3 weeks ago

This PR resolves Issue#236

Added UI element for cards: image image

Added API modifications for persisting a quote for a day: image

Summary by CodeRabbit

vercel[bot] commented 3 weeks ago

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

Name Status Preview Comments Updated (UTC)
github-readme-quotes ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 8, 2024 1:48pm
github-readme-quotes-returns ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 8, 2024 1:48pm
vercel[bot] commented 3 weeks ago

@4nshuman is attempting to deploy a commit to the shravan20's projects Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

The changes introduce a new feature for selecting quote types in the application, enhancing user interaction. A new state variable, quoteType, is implemented in the Home component, allowing users to choose between different quote types via an Autocomplete component. This selection influences the rendering of the TemplateCard and modifies the API to accommodate the new quote type parameter, improving the overall functionality of quote retrieval and display.

Changes

Files Change Summary
frontend/src/components/Pages/Home/index.js Added a state variable quoteType to manage quote selection through an Autocomplete component, passing it to TemplateCard.
frontend/src/components/organisms/TemplateCard/index.js Updated quoteUrl to include a new quoteType parameter for dynamic URL generation based on selected quote type.
frontend/src/config/cardTemplate/index.js Introduced a new constant quoteTypes with options 'random' and 'quote-for-the-day' for dynamic content generation.
src/api/controllers/quotesController.js Improved code formatting and organization in quoteController, maintaining existing logic and error handling.
src/api/routes/quotes-router.js Added quoteType parameter to API documentation, specifying type, default value, and possible values for enhanced functionality.
src/api/services/quotesService.js Enhanced getQuote function by adding quoteType parameter and introducing getQuoteIndex helper function for dynamic quote selection based on type requested.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Home
    participant TemplateCard
    participant QuotesService

    User->>Home: Select quote type
    Home->>TemplateCard: Pass selected quoteType
    TemplateCard->>QuotesService: Request quote with quoteType
    QuotesService-->>TemplateCard: Return selected quote
    TemplateCard-->>Home: Render quote

🐇
In a field of dreams, I hop and play,
With quotes to share, brightening the day!
A type to choose, oh what a delight,
From random to wisdom, all feels just right!
So let’s celebrate, with joy and cheer,
For quotes now dance, bringing us near! 🌼✨

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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration 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.
4nshuman commented 3 weeks ago

@shravan20, Please review the changes