Update README to reflect .env file naming#202
Conversation
make it follow the file in the drizzle.config.ts
|
@yamz8 is attempting to deploy a commit to the Vercel Labs Team on Vercel. A member of the Team first needs to authorize it. |
| cd coding-agent-template | ||
| pnpm install | ||
| # Set up .env.local with required variables | ||
| # Set up .env with required variables |
There was a problem hiding this comment.
| # Set up .env with required variables | |
| # Set up .env.local with required variables |
The Quick Start section now references .env for environment variables, but the detailed "Local Development Setup" section still references .env.local. This inconsistency will confuse developers during setup.
View Details
Analysis
Documentation inconsistency: Quick Start references wrong environment file
What fails: README.md Quick Start section (line 46) instructs developers to "Set up .env with required variables" while the detailed "Local Development Setup" section (line 188) instructs to "Create a .env.local file with your values". This creates conflicting setup instructions for local development.
How to reproduce:
- Read line 46 in Quick Start - says to use
.env - Read line 188 in "Local Development Setup" - says to use
.env.local - Developer follows Quick Start and creates
.env, then encounters different instructions in detailed setup
Result: Developers are confused about which file to use since Quick Start contradicts the detailed setup section.
Expected: Per Next.js environment variables documentation, .env.local is the standard convention for local development - it allows developers to override defaults without committing sensitive values to version control. The gitignore pattern .env* is specifically designed to ignore .env.local for local development.
Fix: Updated line 46 to reference .env.local to align with line 188 and follow Next.js best practices.
make it follow the file in the drizzle.config.ts