Skip to content
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.

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

README: change intended location of .env file from project root to working directory #815

Merged
merged 2 commits into from
Feb 22, 2024
Merged

README: change intended location of .env file from project root to working directory #815

merged 2 commits into from
Feb 22, 2024

Conversation

stefanneuhaus
Copy link
Contributor

Although this is correctly explained further down in the section on Config options, being not 100% correct in this "Hello World" example can cause unnecessary confusion in the first place.

@motdotla
Copy link
Owner

i understand. i'm just concerned this might cause more confusion for the typical path - which is root.

can you describe the situation you were in that it was confusing? was it a monorepo?

@stefanneuhaus
Copy link
Contributor Author

I agree, having a simple introductory example is nice. In "my" case an undergraduate of mine spent hours analyzing the issue for her project with a project structure like backend/app.js. This might be an unusual structure, but still.
Maybe there is a better phrase that is both simple and less misleading in those cases.

@motdotla
Copy link
Owner

can you change the text to something like:

...eate a `.env` file in the root of your project. (if using a monorepo structure like `apps/backend/app.js`, you should put in the root of your backend folder where your app.js process runs)

Rework explanation
@stefanneuhaus
Copy link
Contributor Author

I updated the text accordingly.

@motdotla
Copy link
Owner

thanks!

@motdotla motdotla merged commit fe58fef into motdotla:master Feb 22, 2024
6 checks passed
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