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

chore: Add dev container infrastructure #4842

Conversation

ianjmacintosh
Copy link

@ianjmacintosh ianjmacintosh commented Oct 28, 2024

Because

I wanted to contribute to this project but setup took me a while. These changes will help other engineers get up and running with a remote dev environment running this project dramatically faster than manually going through the local setup process.

Using GitHub Codespaces' free tier, I can push a button directly within the GitHub web UI and have a brand new isolated environment running The Odin Project in about 5 minutes

This PR

Additional Information

Although I mention GitHub Codespaces because it's what I personally use, other organizations like CodeSandbox and DevPod also support dev containers, I'm just much less familiar with them.

To try it out yourself, pull this branch to your fork, navigate to it in the GitHub UI, and from the "Code" dropdown choose "+" to create a new workspace:
GitHub web UI to create a new Codespace

After your codespace is up and running, type bin/dev in your terminal to start your web server. VS Code Web will open a dialog window telling you how to connect in your web browser. The URL will look something like:

https://ominous-foggy-bog-v7q45rpqr7hwxvp-3000.app.github.dev/

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project Contributing Guide
  • The title of this PR follows the keyword: brief description of change format, using one of the following keywords:
    • Feature - adds new or amends existing user-facing behavior
    • Chore - changes that have no user-facing value, refactors, dependency bumps, etc
    • Fix - bug fixes
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • I have verified all tests and linters pass after making these changes.
  • If this PR addresses an open issue, it is linked in the Issue section
  • If applicable, this PR includes new or updated automated tests

If someone needs it, they can install it on their own
Also correct the install instructions for Chrome
Set postgres credentials
rbenv and rvm cannot live side-by-side
Also remove unnecessary comment about .env
Also add some instructions for how to get started
Maybe the failures from before were due to bad syntax?
@KevinMulhern
Copy link
Member

Hey @ianjmacintosh, we appreciate you taking the time to do this. But we talked it over within the team, and it isn't something we'd be willing to maintain at the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants