Skip to content

Commit 69268c7

Browse files
davidwesstdpaquette
andcommitted
DevContainer/Codespaces Documentation (#155)
* added getting started section to README.md. Resolves #127 * Update README.md Co-authored-by: David Paquette <david.paquette@usask.ca>
1 parent 9fbb1cf commit 69268c7

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,21 @@ For many years, we’ve been talking about the importance of being prepared for
2929
**Use this application as a means to prepare to become two weeks ready.**
3030

3131
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)
32+
33+
## Getting Started
34+
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.
35+
36+
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.
37+
38+
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.
39+
40+
### Resources
41+
- [Tutorial Video from @davidwesst][1]
42+
- [Docker Desktop][2]
43+
- [Developing with VSCode and DevContainers][3]
44+
- [Developing with VSCode and GitHub Codespaces][4]
45+
46+
[1]: https://www.youtube.com/watch?v=rYfsNBODfZc
47+
[2]: https://www.docker.com/products/personal/
48+
[3]: https://code.visualstudio.com/docs/remote/containers#_quick-start-try-a-development-container
49+
[4]: https://code.visualstudio.com/docs/remote/codespaces

0 commit comments

Comments
 (0)