Skip to content

Update README to reflect .env file naming #202

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.

Sign up for GitHub

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

Open
yamz8 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README to reflect .env file naming #202

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Or run locally:
git clone https://github.com/vercel-labs/coding-agent-template.git
cd coding-agent-template
pnpm install
# Set up .env.local with required variables
# Set up .env with required variables
Copy link
Contributor

@vercel vercel bot Nov 17, 2025

Choose a reason for hiding this comment

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

Suggested change
# 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:

  1. Read line 46 in Quick Start - says to use .env
  2. Read line 188 in "Local Development Setup" - says to use .env.local
  3. 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.

pnpm db:push
pnpm dev
```
Expand Down