Skip to content

DevContainer/Codespaces Documentation #155

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

Merged
merged 2 commits into from
May 2, 2022
Merged

DevContainer/Codespaces Documentation #155

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4ace78
added getting started section to README.md. Resolves #127
davidwesst May 1, 2022
204e721
Update README.md
dpaquette May 2, 2022
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
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,21 @@ For many years, we’ve been talking about the importance of being prepared for
**Use this application as a means to prepare to become two weeks ready.**

For additional details, questions, etc. You can reach out out to Pascal @schuback or Richard @richcampbell on twitter and/or join our hackathon dev channel on slack (https://join.slack.com/share/enQtMzE4MjQ4MTUzMzM2Ny0yNWE1OGJlMGIwNDJmMTI5MTEyYTVmMDViNzBmMThjYzkyOTk3ZDQwNTgyZGU1YjI3ZTA3ZmEyZjU5MDU1MGRk). (LINK posted 3/5 and expires 14 days after)

## Getting Started
This project is configured to work with DevContainers/Codespaces to get developers up and running as quickly as possible. For DevContainers, all you need is [Docker][2] installed and you should be good to go! For Codespaces, you will need a GitHub account wiht Codespaces enabled.

To see a full demo on how to setup your DevContainer/Codespaces environment, check out [this video][1] from @davidwesst where he walks through setting up HTBox/TwoWeeksReady, executing the various development tasks, and provides an overview about DevContainers and Codespaces.

To setup your own development environment from scratch or to install the dependendies locally, refer to the files [`.devcontainer/devcontainer.json`](https://github.com/HTBox/TwoWeeksReady/blob/main/.devcontainer/devcontainer.json) and [`.devcontainer/Dockerfile`](https://github.com/HTBox/TwoWeeksReady/blob/main/.devcontainer/devcontainer.json) to understand what tools are required.

### Resources
- [Tutorial Video from @davidwesst][1]
- [Docker Desktop][2]
- [Developing with VSCode and DevContainers][3]
- [Developing with VSCode and GitHub Codespaces][4]

[1]: https://www.youtube.com/watch?v=rYfsNBODfZc
[2]: https://www.docker.com/products/personal/
[3]: https://code.visualstudio.com/docs/remote/containers#_quick-start-try-a-development-container
[4]: https://code.visualstudio.com/docs/remote/codespaces