Skip to content

docs: update .env.example with all required variables#347

Merged
saddlepaddle merged 1 commit intomainfrom
update-env-example
Dec 13, 2025
Merged

docs: update .env.example with all required variables#347
saddlepaddle merged 1 commit intomainfrom
update-env-example

Conversation

@saddlepaddle
Copy link
Copy Markdown
Collaborator

@saddlepaddle saddlepaddle commented Dec 13, 2025

Summary

  • Add all environment variables needed for local development
  • Organize variables by category (Database, Neon, Clerk, App URLs, Blob Storage, Desktop)
  • Include placeholder values to guide new developers

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Updated configuration templates to support new integrations and services, including authentication, database connectivity, blob storage, and multi-environment URL management.

✏️ Tip: You can customize this high-level summary in your review settings.

Add all environment variables needed for local development including
database, Neon, Clerk auth, app URLs, and Vercel Blob storage configs.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Dec 13, 2025

Walkthrough

The .env.example file is updated to replace deprecated environment variables with new ones for Neon database pooling, Clerk authentication, multiple application URLs, and blob storage configuration. The desktop app section is reorganized to clarify development server settings.

Changes

Cohort / File(s) Summary
Environment Configuration
\.env\.example
Removed legacy VITE_DEV_SERVER_PORT and WEBSITE_URL variables. Added DATABASE_URL_UNPOOLED for PostgreSQL connectivity. Introduced Neon integration variables (API key, org ID, project ID, branch ID). Added Clerk authentication variables (secret key, webhook secret, publishable key). Included multi-service URL configuration (web, API, admin, marketing, docs). Added BLOB_READ_WRITE_TOKEN. Reorganized VITE_DEV_SERVER_PORT under Desktop App section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Configuration file update with no logic or code changes; primarily environment variable placeholder additions and reorganization
  • No dependencies, imports, or code flow modifications to evaluate

Possibly related PRs

Poem

🐰 Env files spring forth with variables new,
Neon and Clerk and URLs too,
Pooling and tokens, a config's delight,
The infrastructure blooms in December light!

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description is missing required template sections like Related Issues, Type of Change, Testing, Screenshots, and Additional Notes. Complete the PR description using the repository template. Add Type of Change (mark 'Documentation'), Related Issues if applicable, and Testing/Additional Notes sections.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: updating .env.example with required environment variables for development.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch update-env-example

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

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
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

🧹 Nitpick comments (1)
.env.example (1)

1-28: Well-organized environment variables for local development.

The additions provide comprehensive configuration coverage for Neon database pooling, Clerk authentication, multiple service URLs, and blob storage. The categorical grouping with clear comments improves developer onboarding.

However, static analysis flagged several keys that are not alphabetically ordered within their sections. If alphabetical ordering is a project convention (enforced by dotenv-linter), consider reordering the keys:

  • Neon section (lines 6–9): NEON_BRANCH_ID should precede NEON_ORG_ID
  • App URLs section (lines 17–22): reorder to NEXT_PUBLIC_ADMIN_URL, NEXT_PUBLIC_API_URL, NEXT_PUBLIC_COOKIE_DOMAIN, NEXT_PUBLIC_DOCS_URL, NEXT_PUBLIC_MARKETING_URL, NEXT_PUBLIC_WEB_URL
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1c98488 and 031ee96.

📒 Files selected for processing (1)
  • .env.example (1 hunks)
🧰 Additional context used
🪛 dotenv-linter (4.0.0)
.env.example

[warning] 9-9: [UnorderedKey] The NEON_BRANCH_ID key should go before the NEON_ORG_ID key

(UnorderedKey)


[warning] 18-18: [UnorderedKey] The NEXT_PUBLIC_API_URL key should go before the NEXT_PUBLIC_WEB_URL key

(UnorderedKey)


[warning] 19-19: [UnorderedKey] The NEXT_PUBLIC_ADMIN_URL key should go before the NEXT_PUBLIC_API_URL key

(UnorderedKey)


[warning] 20-20: [UnorderedKey] The NEXT_PUBLIC_MARKETING_URL key should go before the NEXT_PUBLIC_WEB_URL key

(UnorderedKey)


[warning] 21-21: [UnorderedKey] The NEXT_PUBLIC_DOCS_URL key should go before the NEXT_PUBLIC_MARKETING_URL key

(UnorderedKey)


[warning] 22-22: [UnorderedKey] The NEXT_PUBLIC_COOKIE_DOMAIN key should go before the NEXT_PUBLIC_DOCS_URL key

(UnorderedKey)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (6)
  • GitHub Check: Deploy Marketing
  • GitHub Check: Deploy API
  • GitHub Check: Deploy Docs
  • GitHub Check: Deploy Admin
  • GitHub Check: Deploy Web
  • GitHub Check: Build

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Dec 13, 2025

🧹 Preview Cleanup Complete

The following preview resources have been cleaned up:

Service Status
Neon Database (Neon)

Thank you for your contribution! 🎉


Preview resources have been processed for cleanup

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.

1 participant