docs: update .env.example with all required variables#347
Conversation
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>
WalkthroughThe Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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_IDshould precedeNEON_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
📒 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
Summary
🤖 Generated with Claude Code
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.