From d4ace78a5629180308ae9fae1b81f2a923cf641d Mon Sep 17 00:00:00 2001 From: David Wesst Date: Sun, 1 May 2022 14:50:58 -0500 Subject: [PATCH 1/2] added getting started section to README.md. Resolves #127 --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index 6ed5b56..4566e6e 100644 --- a/README.md +++ b/README.md @@ -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, ll 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 \ No newline at end of file From 204e72155dc48ee5750ac75cd16919bda3c6e8bb Mon Sep 17 00:00:00 2001 From: David Paquette Date: Sun, 1 May 2022 19:42:29 -0600 Subject: [PATCH 2/2] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4566e6e..46a79db 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ For many years, we’ve been talking about the importance of being prepared for 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, ll you need is [Docker][2] installed and you should be good to go! For Codespaces, you will need a GitHub account wiht Codespaces enabled. +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.