diff --git a/docs/src/assets/codespaces.png b/docs/src/assets/codespaces.png new file mode 100644 index 0000000..2b8e8a4 Binary files /dev/null and b/docs/src/assets/codespaces.png differ diff --git a/docs/src/content/docs/guides/getting-started.md b/docs/src/content/docs/guides/getting-started.md index 9e9b278..e707fa3 100644 --- a/docs/src/content/docs/guides/getting-started.md +++ b/docs/src/content/docs/guides/getting-started.md @@ -5,6 +5,7 @@ contributors: - tomalaforge - 1fbr - ho-ssain + - jdegand sidebar: order: 1 --- @@ -18,7 +19,7 @@ If you wish to submit an answer, you will need to have your own GitHub account. ## Fork the GitHub project Navigate to the [Angular Challenges Repository](https://github.com/tomalaforge/angular-challenges) and click on the Fork button in the header. This will create a copy of this repository on your own GitHub page. +Fork button in the header. This will create a copy of this repository on your own GitHub profile. ## Clone the repository to your local machine @@ -59,3 +60,23 @@ Each challenge consists of: - 🟢 easy - 🟠 medium - 🔴 difficult + +## (Alternately) Use GitHub Codespaces + +From your own instance of the Angular Challenges repository, click the code button and navigate to the codespaces tab. + +![Codespaces tab](../../../assets/codespaces.png) + +Click the `Create codespace on main` button, and you will navigate to a GitHub codespace. + +If you never used a GitHub codespace before, I would recommend you try this short interactive [GitHub Skills Tutorial](https://github.com/skills/code-with-codespaces). + +When you navigate to the codespace, there will be a prompt to install the recommended `VS Code` plugins. If you plan on creating a challenge, you can use the `Nx plugin` to generate the starter code. Either way, the codespace will install the dependencies, and you can create a new branch, tackle any challenge, and create a pull request. + +When you push to a branch, you do not have to provide a GitHub token. + +Once you are finished, remember to pause or delete your codespace. If you don't, GitHub will automatically pause an idle codespace after 30 minutes. You do have a generous amount of free codespace time per month, but it is still important not to waste your allotment. + +In the GitHub codespace, copy and paste will be blocked until you give permission. + +The GitHub codespace uses port forwarding to serve the projects. Click the prompt after running `npx nx serve [project-name]` to navigate to `localhost:4200`.