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

feat(sidebar): add SIDEBAR_TITLE and SIDEBAR_SUBTITLE config for cust… #5012

Closed
wants to merge 7 commits into from

Conversation

kiritoko1029
Copy link

@kiritoko1029 kiritoko1029 commented Jul 15, 2024

…om sidebar information

Summary by CodeRabbit

  • New Features

    • Dynamic configuration for site title, description, and logo URL based on server-side settings.
    • Sidebar titles and subtitles now dynamically rendered from server-side configuration.
  • Improvements

    • Metadata title in the site layout is now dynamically set from server configuration.
    • Improved readability for viewport meta tag in the layout.
  • Infrastructure

    • Updates to GitHub workflow configurations for building and pushing Docker images.

Copy link
Contributor

coderabbitai bot commented Jul 15, 2024

Warning

Rate limit exceeded

@kiritoko1029 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 10 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 92a00c5 and 4512e7a.

Walkthrough

The updates encompass various areas, including configuration, server-side settings, and UI components. Environment variables were introduced for dynamic site customization, while Docker workflow improvements were made. Key UI components and metadata now dynamically utilize server-side configurations, enhancing flexibility and maintainability.

Changes

File Change Summary
.env.template Included new optional configurations for SITE_TITLE, SITE_DESCRIPTION, SITE_LOGO_URL, SIDEBAR_TITLE, and SIDEBAR_SUBTITLE.
.github/workflows/docker.yml Modified job configurations for Docker image building and pushing, including setting up QEMU and Docker Buildx.
app/components/exporter.tsx Added getServerSideConfig import and utilized it to dynamically set siteTitle and siteDescription in ImagePreviewer.
app/components/sidebar.tsx Imported getServerSideConfig and used it to render sidebar title and subtitle dynamically.
app/config/server.ts Introduced custom configurations for site title, description, and logo URL within getServerSideConfig.
app/layout.tsx Set metadata title dynamically from serverConfig.siteTitle and reformatted viewport meta tag.
app/store/update.ts Used getServerSideConfig to dynamically set notification titles.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Browser
    participant Server
    participant Config

    User->>Browser: Request Page
    Browser->>Server: Fetch Metadata
    Server->>Config: Get Server-Side Config
    Config-->>Server: Return Config (siteTitle, siteDescription)
    Server->>Browser: Send Metadata (including siteTitle)
    Browser->>User: Render Page with Dynamic Title
Loading

Poem

"In the fields, configurations dance,
With titles, logos taking a chance.
Dynamic flows and smart designs,
The site now reads between the lines.
Docker sails on smoother seas,
Updating with a breeze!"
🐇🖥️✨


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.

Copy link
Contributor

@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 b9d1dca and 851d2d1.

Files selected for processing (3)
  • .env.template (1 hunks)
  • app/components/sidebar.tsx (4 hunks)
  • app/config/server.ts (3 hunks)
Files skipped from review due to trivial changes (1)
  • .env.template
Additional comments not posted (4)
app/config/server.ts (2)

58-62: LGTM! Environment variable declarations are correct.

The new environment variables SIDEBAR_TITLE and SIDEBAR_SUB_TITLE are correctly declared.


132-135: LGTM! Logic for handling sidebar title and subtitle is correct.

The logic correctly fetches the sidebar title and subtitle from environment variables and sets default values if they are not provided.

Also applies to: 184-185

app/components/sidebar.tsx (2)

33-33: LGTM! Import statement is correct.

The getServerSideConfig function is correctly imported to fetch server-side configurations.


143-143: LGTM! Sidebar title and subtitle are correctly rendered.

The sidebar title and subtitle are dynamically rendered based on the server-side configurations fetched using getServerSideConfig.

Also applies to: 158-161

Copy link
Contributor

Your build has completed!

Preview deployment

@Dogtiti
Copy link
Member

Dogtiti commented Jul 15, 2024

@lloydzhou If customization is needed, it's important to check if there are any other requirements. If there are, they should be added comprehensively. such as logo ?

Copy link

vercel bot commented Jul 15, 2024

@kiritoko1029 is attempting to deploy a commit to the NextChat Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

@lloydzhou lloydzhou left a comment

Choose a reason for hiding this comment

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

  1. add config logo
  2. maybe rename siderbar to site ?

Copy link
Contributor

@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: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 851d2d1 and 92a00c5.

Files selected for processing (7)
  • .env.template (1 hunks)
  • .github/workflows/docker.yml (3 hunks)
  • app/components/exporter.tsx (3 hunks)
  • app/components/sidebar.tsx (4 hunks)
  • app/config/server.ts (3 hunks)
  • app/layout.tsx (2 hunks)
  • app/store/update.ts (3 hunks)
Files skipped from review as they are similar to previous changes (2)
  • .env.template
  • app/config/server.ts
Additional context used
Biome
app/components/sidebar.tsx

[error] 162-162: Avoid redundant double-negation.

It is not necessary to use double-negation when a value will already be coerced to a boolean.
Unsafe fix: Remove redundant double-negation

(lint/complexity/noExtraBooleanCast)

Additional comments not posted (15)
.github/workflows/docker.yml (4)

22-23: LGTM! The metadata extraction step is correctly configured.

The step to extract metadata for Docker images is well-integrated into the workflow.


32-33: LGTM! The QEMU setup step is correctly configured.

The step to set up QEMU for multi-platform builds is well-integrated into the workflow.


37-40: LGTM! The Docker Buildx setup step is correctly configured.

The step to set up Docker Buildx for building and pushing Docker images is well-integrated into the workflow.


Line range hint 41-52:
LGTM! The build and push step is correctly configured.

The step to build and push Docker images using Docker Buildx is well-integrated into the workflow.

app/layout.tsx (3)

13-16: LGTM! The metadata title and apple web app title are correctly set.

The metadata title and apple web app title are dynamically set to serverConfig.siteTitle, enhancing flexibility.


40-43: LGTM! The viewport meta tag is correctly formatted.

The viewport meta tag is reformatted for improved readability, enhancing maintainability.


13-13: LGTM! The server-side configuration is correctly imported and used.

The server-side configuration is correctly imported and used to dynamically set metadata, enhancing flexibility.

app/store/update.ts (3)

14-14: LGTM! The import statement is correct.

The getServerSideConfig function is correctly imported from @/app/config/server.


18-18: LGTM! The server-side configuration is correctly initialized.

The serverConfig is correctly initialized using getServerSideConfig, enhancing flexibility.


Line range hint 111-121:
LGTM! The notification titles are correctly set.

The notification titles are dynamically set using serverConfig, enhancing flexibility.

app/components/sidebar.tsx (3)

33-33: LGTM! The import statement is correct.

The getServerSideConfig function is correctly imported from ../config/server.


143-143: LGTM! The server-side configuration is correctly initialized and destructured.

The serverConfig is correctly initialized and destructured to get siteTitle, siteDescription, and siteLogURL, enhancing flexibility.


158-160: LGTM! The sidebar title and subtitle are correctly rendered.

The sidebar title and subtitle are dynamically rendered using siteTitle and siteDescription, enhancing flexibility.

app/components/exporter.tsx (2)

43-43: Import statement approved.

The getServerSideConfig function is correctly imported for dynamic configuration retrieval.


Line range hint 519-544:
Usage of siteTitle and siteDescription approved.

The siteTitle and siteDescription are correctly retrieved from getServerSideConfig and used in the JSX structure.

Comment on lines 162 to 166
{!!siteLogURL ? (
<img src={"https://unsplash.it/40/43?random"}></img>
) : (
<ChatGptIcon />
)}
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove redundant double-negation.

The sidebar logo is correctly rendered using siteLogURL and the default logo. However, the double-negation is redundant and can be removed.

-  {!!siteLogURL ? (
+  {siteLogURL ? (
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
{!!siteLogURL ? (
<img src={"https://unsplash.it/40/43?random"}></img>
) : (
<ChatGptIcon />
)}
{siteLogURL ? (
<img src={"https://unsplash.it/40/43?random"}></img>
) : (
<ChatGptIcon />
)}
Tools
Biome

[error] 162-162: Avoid redundant double-negation.

It is not necessary to use double-negation when a value will already be coerced to a boolean.
Unsafe fix: Remove redundant double-negation

(lint/complexity/noExtraBooleanCast)

@kiritoko1029
Copy link
Author

  1. add config logo
  2. maybe rename siderbar to site ?

@Issues-translate-bot
Copy link

Bot detected the issue body's language is not English, translate it automatically.


  1. add config logo
  2. maybe rename siderbar to site ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants