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

Feature Request: Running The Odin Project Locally - clarify instructions #4801

Open
3 tasks done
thereisnodeveloper opened this issue Sep 4, 2024 · 1 comment
Open
3 tasks done
Labels
Status: Needs Review This issue/PR needs an initial or additional review

Comments

@thereisnodeveloper
Copy link

thereisnodeveloper commented Sep 4, 2024

Checks

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this issue follows the Feature Request: brief description of feature request format, e.g. Feature Request: Add a dark mode to the website
  • 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 clear env.sample is 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

@thereisnodeveloper thereisnodeveloper added the Status: Needs Review This issue/PR needs an initial or additional review label Sep 4, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog / Ideas in Main Site Sep 4, 2024
@CouchofTomato
Copy link
Member

@KevinMulhern Thoughts on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Review This issue/PR needs an initial or additional review
Projects
Status: 📋 Backlog / Ideas
Development

No branches or pull requests

2 participants