Skip to content

Commit e6fd546

Browse files
authored
feat: add codespace docs (tomalaforge#987)
* feat: add codespace docs * fix: image & typo * docs: update codespace directions * fix: typos & omissions * fix: 2 typos * docs: move codespace directions after local * fix: change npx command
1 parent 59bad32 commit e6fd546

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

docs/src/assets/codespaces.png

32 KB
Loading

docs/src/content/docs/guides/getting-started.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ contributors:
55
- tomalaforge
66
- 1fbr
77
- ho-ssain
8+
- jdegand
89
sidebar:
910
order: 1
1011
---
@@ -18,7 +19,7 @@ If you wish to submit an answer, you will need to have your own GitHub account.
1819
## Fork the GitHub project
1920

2021
Navigate to the [Angular Challenges Repository](https://github.com/tomalaforge/angular-challenges) and click on the <span class="github-neutral-btn"> <svg aria-hidden="true" height="16" viewBox="0 0 16 16" version="1.1" width="16" data-view-component="true" class="octicon octicon-repo-forked mr-2">
21-
<path d="M5 5.372v.878c0 .414.336.75.75.75h4.5a.75.75 0 0 0 .75-.75v-.878a2.25 2.25 0 1 1 1.5 0v.878a2.25 2.25 0 0 1-2.25 2.25h-1.5v2.128a2.251 2.251 0 1 1-1.5 0V8.5h-1.5A2.25 2.25 0 0 1 3.5 6.25v-.878a2.25 2.25 0 1 1 1.5 0ZM5 3.25a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Zm6.75.75a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5Zm-3 8.75a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Z"></path></svg>Fork</span> button in the header. This will create a copy of this repository on your own GitHub page.
22+
<path d="M5 5.372v.878c0 .414.336.75.75.75h4.5a.75.75 0 0 0 .75-.75v-.878a2.25 2.25 0 1 1 1.5 0v.878a2.25 2.25 0 0 1-2.25 2.25h-1.5v2.128a2.251 2.251 0 1 1-1.5 0V8.5h-1.5A2.25 2.25 0 0 1 3.5 6.25v-.878a2.25 2.25 0 1 1 1.5 0ZM5 3.25a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Zm6.75.75a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5Zm-3 8.75a.75.75 0 1 0-1.5 0 .75.75 0 0 0 1.5 0Z"></path></svg>Fork</span> button in the header. This will create a copy of this repository on your own GitHub profile.
2223

2324
## Clone the repository to your local machine
2425

@@ -59,3 +60,23 @@ Each challenge consists of:
5960
- 🟢 easy
6061
- 🟠 medium
6162
- 🔴 difficult
63+
64+
## (Alternately) Use GitHub Codespaces
65+
66+
From your <b>own instance</b> of the Angular Challenges repository, click the code button and navigate to the codespaces tab.
67+
68+
![Codespaces tab](../../../assets/codespaces.png)
69+
70+
Click the `Create codespace on main` button, and you will navigate to a GitHub codespace.
71+
72+
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).
73+
74+
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.
75+
76+
When you push to a branch, you do not have to provide a GitHub token.
77+
78+
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.
79+
80+
In the GitHub codespace, copy and paste will be blocked until you give permission.
81+
82+
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`.

0 commit comments

Comments
 (0)