Skip to content

docs: add citrusmail template - #2638

Open
ethannschwartz wants to merge 1 commit into
nuxt:mainfrom
ethannschwartz:docs/add-citrusmail-template
Open

ethannschwartz wants to merge 1 commit into
nuxt:mainfrom
ethannschwartz:docs/add-citrusmail-template

Conversation

@ethannschwartz

Copy link
Copy Markdown

📚 Description

Adds CitrusMail to the templates page. It's an open-source (MIT) mail, calendar and contacts client built with Nuxt 4 and Nuxt UI. It signs in to any IMAP, POP3 or JMAP provider, with CalDAV and CardDAV for calendars and contacts. It's a GitHub template meant to be rebranded as your own mail client: the name, logo, colours and locked-down server settings all come from environment variables, and it also builds as a Mac, Windows and Linux desktop app with Electron.

  • Demo: https://faivelo.com/citrus-mail
  • NUXT_APP_SECRET is required, since it encrypts the session cookie, so it's listed under deploy.env.
  • Checked on a fresh clone with Node 22: pnpm install --frozen-lockfile, pnpm build and node .output/server/index.mjs all succeed.

The screenshot shows the app signed in to a local test mailbox. All names and messages in it are made up.

CitrusMail

🤖 Generated with Claude Code

https://claude.ai/code/session_017nAbGmGef4NeQdDkmSUiJa

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017nAbGmGef4NeQdDkmSUiJa
@vercel

vercel Bot commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

@citrusmail is attempting to deploy a commit to the Nuxt Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions

github-actions Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

nuxt.com preview

A maintainer can add the preview:enabled label to preview this pull request on nuxt.com.

@coderabbitai

coderabbitai Bot commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The change adds a CitrusMail template entry. It includes the template’s name, slug, description, repository, demo URL, and app category. Its deployment configuration requires the NUXT_APP_SECRET environment variable.

Estimated code review effort: 1 (Trivial) | ~4 minutes

Merge Risk: Minimal · up to 96106

This adds a CitrusMail entry to the templates page with documentation-only content. No actionable merge-blocking risk remains.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title "docs: add citrusmail template" matches the main change. The changeset adds CitrusMail metadata to the templates content (content/templates/citrusmail.yml, +9 lines), which is the single cha…
Description check Passed The description explains the purpose of the change. It says the PR adds CitrusMail to the templates page, gives the demo URL, and notes that NUXT_APP_SECRET is listed under deploy.env. These details m…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "docs: add citrusmail template" matches the main change. The changeset adds CitrusMail metadata to the templates content (content/templates/citrusmail.yml, +9 lines), which is the single change in scope. The title is short, specific and follows a conventional prefix.

Full details: Description check

Explanation

The description explains the purpose of the change. It says the PR adds CitrusMail to the templates page, gives the demo URL, and notes that NUXT_APP_SECRET is listed under deploy.env. These details match the template metadata added in the changeset.

Finishing Touches

Generate unit tests (beta)

  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: d3533cd4-7657-4e37-a0fe-61c0f6fe04e4
Commits

Reviewing files that changed from the base of the PR and between 15c1ea3 and 9610620.

Files selected for processing: 2

  • content/templates/citrusmail.yml
  • public/assets/templates/citrusmail.webp

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 1 remain after this review.

@nuxt-com-bundle-report

nuxt-com-bundle-report Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

Bundle size

Explore the comparison →

Client 1.32 MB $\color{red}\textsf{(+43 B, +0.0}\%\textsf{)}$ · Server 8.07 MB $\color{red}\textsf{(+820 B, +0.0}\%\textsf{)}$

No route loads 100 B more or less before it renders.

Largest changes in the server
Package or file Base PR Δ
[unassigned] 6.81 MB 6.81 MB +448 B (+0.0%)
.nuxt/dist/server/_nuxt/slug-styles.CVjTbRKd.mjs 87 B n/a −87 B (−100.0%)
.nuxt/dist/server/_nuxt/slug-styles-2.DHmaf5JZ.mjs n/a 86 B +86 B
.nuxt/dist/server/_nuxt/slug-styles.DM6jAnhr.mjs n/a 84 B +84 B
.nuxt/dist/server/_nuxt/slug-styles-2.CC_ke4dZ.mjs 78 B n/a −78 B (−100.0%)
.nuxt/dist/server/_nuxt/index-styles.DKFMxiIM.mjs n/a 76 B +76 B
.nuxt/dist/server/_nuxt/index-styles.DbAAZlrt.mjs 75 B n/a −75 B (−100.0%)

Brotli sizes. Changes under 100 B are left out of the tables. Measured by nuxt-bundle-analyzer for 9610620.

@HugoRCD HugoRCD closed this Nov 12, 2026
@HugoRCD HugoRCD reopened this Nov 12, 2026
@ethannschwartz

Copy link
Copy Markdown
Author

Makes sense, thanks Hugo! Closing this.

@ethannschwartz

Copy link
Copy Markdown
Author

Totally understand, thanks Hugo! For context in case it helps it stand out later: CitrusMail had 120+ clones this week and has been downloaded nearly 500 times, and people are really liking it. I'm sure you get a lot of PRs lately, so no worries either way. Thanks anyway!

@HugoRCD

HugoRCD commented Nov 12, 2026

Copy link
Copy Markdown
Member

Makes sense, thanks Hugo! Closing this.

It was actually a mistake, I didn't realise at first this was a template submission and not showcase 😭 That's why I reopen the PR

@ethannschwartz

Copy link
Copy Markdown
Author

Ah, no worries, thanks for reopening! My bad for closing it, reopened it now.

@ethannschwartz

Copy link
Copy Markdown
Author

Ah, no worries, thanks for reopening! My bad for closing it, reopened it now.

And hey, if you change your mind and want to throw it in with the showcases, we wouldn't mind!

This branch has not been deployed

No deployments
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.

2 participants