TheOdinProject
Feature Request: Running The Odin Project Locally - clarify instructions
Checks
- [X] I have thoroughly read and understand The Odin Project Contributing Guide
- [X] The title of this issue follows the
Feature Request: brief description of feature requestformat, e.g.Feature Request: Add a dark mode to the website - [X] Would you like to work on this issue?
Description of the Feature Request
Currently, the "Set Up DotEnv" section is missing some instructions / inconsistent.
Acceptance criteria
-
[ ] Guide needs to be tell the reader to "cd" into the local TOP repository before asking the reader to run
cp env.sample .env(make it clearenv.sampleis in the local repository directory) -
[ ] Explicitly tell the reader to set postgress password with
postgres=# \password YOURUSERNAME. That this password will be stored in the .env file in the instructions that follow. Then it should be more clear what the document means by "Then edit the newly created .env file to include your Postgres Username and Password." The Linux Installation Guide currently makes this sound optional.
Additional Comments
No response
Hi @thereisnodeveloper and team, I’ve reviewed the current setup instructions and agree that clarifying the DotEnv and Postgres steps would improve the onboarding experience. I’ve gone through the contributing guide and successfully set up the project locally, so I’d be happy to work on updating the documentation to reflect these suggestions.
Let me know if you'd like me to draft a PR for this. I’ll make sure the instructions are clear, consistent, and beginner-friendly. Thanks for raising this!
Amended wiki instructions accordingly. Don't need to explicitly state "cd into ..." since the top of the instructions indicates the guide assumes you've forked and cloned as per our contributing guide, which includes a cd there (and it's a given you'll need to run the commands for repo stuff in the repo itself). The tweaked wording should suffice for clarity.
