Skip to content

Commit b3862c0

Browse files
ChrisHowdChrisHowd
committed
Add configuration instructions for GitHub Spec Kit lab environment
1 parent 7a2d0ed commit b3862c0

2 files changed

Lines changed: 254 additions & 189 deletions

File tree

‎Instructions/Labs/LAB_AK_00_configure_github_dev_kit_lab.md‎

Lines changed: 247 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,247 @@
1+
---
2+
lab:
3+
title: 'Prepare - Configure your GitHub Spec Kit lab environment'
4+
description: 'Review the lab requirements and configure resources for the GitHub Spec Kit exercises.'
5+
---
6+
7+
# Configure your GitHub Spec Kit lab environment
8+
9+
Before you begin the Spec-Driven Development with GitHub Dev Kit lab exercise, you need to ensure that your development environment includes the required tools and resources.
10+
11+
Your lab environment must include the following resources:
12+
13+
- Git version 2.48 or later.
14+
- The .NET SDK version 8.0 or later.
15+
- Access to a GitHub account with GitHub Copilot enabled.
16+
- Visual Studio Code with the C# Dev Kit and GitHub Copilot Chat extensions.
17+
- SQL Server 2019 LocalDB.
18+
- Python version 3.11 or later.
19+
- The uv package manager.
20+
21+
## Install the GitHub, .NET, and Visual Studio Code resources
22+
23+
The "Spec-Driven Development with GitHub Dev Kit" lab exercise uses GitHub Copilot in Visual Studio Code as the primary AI assistant. To use GitHub Copilot, you need access to a GitHub account with a GitHub Copilot subscription. GitHub requires Git for version control operations. The lab application that you'll be working on was built using .NET (ASP.NET Core 8.0 and Blazor).
24+
25+
Complete the following steps to ensure that the required GitHub, .NET, and Visual Studio Code tools and resources are available.
26+
27+
1. Ensure that Git version 2.48 or later is installed in your lab environment.
28+
29+
Run the following command in a terminal window to check the installed version of Git:
30+
31+
```bash
32+
git --version
33+
```
34+
35+
If you're running Windows and you want to update Git, you can use the following command:
36+
37+
```bash
38+
git update-git-for-windows
39+
```
40+
41+
If necessary, you can download Git using the following URL: <a href="https://git-scm.com/downloads" target="_blank">Download Git</a>.
42+
43+
1. Ensure that Git is configured to use your name and email address.
44+
45+
If required, you can use the following commands to set your Git user name and email address.
46+
47+
> **NOTE**: Update the following commands with your information before you run the commands.
48+
49+
```bash
50+
git config --global user.name "Julie Miller"
51+
```
52+
53+
```bash
54+
git config --global user.email julie.miller@example.com
55+
```
56+
57+
1. Ensure that the .NET 8.0 SDK, or a later version, is installed in your lab environment.
58+
59+
Installing the latest LTS or STS version of the .NET SDK is recommended, however, you can use .NET 8.0 to complete this exercise.
60+
61+
Run the following command in a terminal window to check the installed version of the .NET SDK:
62+
63+
```dotnetcli
64+
dotnet --version
65+
```
66+
67+
If necessary, you can download the .NET SDK using the following URL: <a href="https://dotnet.microsoft.com/download/dotnet" target="_blank">Download .NET SDK</a>.
68+
69+
1. Ensure that the .NET SDK is configured to use the official NuGet.org repository as a source for downloading and restoring packages.
70+
71+
For example, open a terminal window and then run the following command:
72+
73+
```bash
74+
dotnet nuget add source https://api.nuget.org/v3/index.json -n nuget.org
75+
```
76+
77+
1. Ensure that Visual Studio Code and the C# Dev Kit extension are installed in your lab environment.
78+
79+
If necessary, you can download Visual Studio Code using the following URL: <a href="https://code.visualstudio.com/download" target="_blank">Download Visual Studio Code</a>
80+
81+
You can install the C# Dev Kit extension using the Extensions view in Visual Studio Code.
82+
83+
1. Ensure that you have access to a GitHub account and GitHub Copilot subscription.
84+
85+
You can log in to your GitHub account using the following URL: <a href="https://github.com/login" target="_blank">GitHub login</a>.
86+
87+
If you don't have a GitHub account, you can create an individual account from the GitHub login page. On the login page, select **Create an account**.
88+
89+
Open the settings/profile page of your GitHub account and verify that you have access to a GitHub Copilot subscription. If you have an active subscription for GitHub Copilot Pro, GitHub Copilot Pro+, GitHub Copilot Business, or GitHub Copilot Enterprise that you can use for training, you can use your existing GitHub Copilot subscription to complete the GitHub Copilot exercises.
90+
91+
If you have an individual GitHub account, but you don't have a GitHub Copilot subscription, you can set up a GitHub Copilot Free plan from Visual Studio Code during a training exercise.
92+
93+
> **IMPORTANT**: The GitHub Copilot Free plan is a limited version of GitHub Copilot, allowing up to 2,000 code completions and 50 chats or premium requests per month. If you use a GitHub Copilot Free plan outside training exercises, you may exceed the plan's resource limits before completing the training. The GitHub Copilot Free plan is not available for GitHub Copilot Pro, GitHub Copilot Pro+, GitHub Copilot Business, or GitHub Copilot Enterprise subscriptions.
94+
95+
1. Ensure that GitHub Copilot Chat is accessible in your Visual Studio Code environment.
96+
97+
You can install the GitHub Copilot Chat extension using the Extensions view in Visual Studio Code.
98+
99+
## Install lab application dependencies
100+
101+
The application that you're working on during the lab uses a SQL Server LocalDB database to store application data. SQL Server LocalDB is a lightweight version of SQL Server that's ideal for development and testing.
102+
103+
Complete the following steps to ensure that SQL Server LocalDB is installed in your lab environment.
104+
105+
1. Check to see if SQL Server LocalDB is installed in your lab environment.
106+
107+
Run the following command in a terminal window to check for LocalDB installation:
108+
109+
```powershell
110+
sqllocaldb info
111+
```
112+
113+
Expected output: List of LocalDB instances or an empty list if none exist. For example:
114+
115+
```output
116+
MSSQLLocalDB
117+
```
118+
119+
If the command fails or LocalDB is not installed, use the following steps to install SQL Server 2019 LocalDB. Otherwise, skip to the "Install the GitHub Spec Kit tools and resources" section.
120+
121+
1. To download the SQL Server 2019 Express edition installer file, open the following link in a browser: (SQL Server 2019 Express download)[https://go.microsoft.com/fwlink/?LinkID=866658]
122+
123+
1. After the download is complete, open the SQL Server 2019 installer file (for example, **SQL2019-SSEI-Expr.exe**).
124+
125+
1. On the SQL Server 2019 installation wizard, select **Download Media**.
126+
127+
1. Under **Specify SQL Server installer download**, select the **LocalDB** package, and then select the **Download** button.
128+
129+
1. When you see the **Download successful** message, select the **Open folder** button.
130+
131+
1. Run the SQL Server LocalDB installer file (for example, **SqlLocalDB.msi**), and then follow the prompts to complete the installation.
132+
133+
1. To verify the installation, open PowerShell or Command Prompt, and then run the following command:
134+
135+
```powershell
136+
sqllocaldb info
137+
```
138+
139+
You should see a list of LocalDB instances (or an empty list if none exist yet). For example:
140+
141+
```output
142+
MSSQLLocalDB
143+
```
144+
145+
If you need to create the default instance of MSSQLLocalDB, run the following commands:
146+
147+
```powershell
148+
sqllocaldb create MSSQLLocalDB
149+
sqllocaldb start MSSQLLocalDB
150+
```
151+
152+
## Install the GitHub Spec Kit tools and resources
153+
154+
The GitHub Spec Kit's command-line interface (CLI) tool is Python-based and requires Python 3.11 or later. The uv package manager is used to install and manage the GitHub Spec Kit CLI tool.
155+
156+
Complete the following steps to install and configure the GitHub Spec Kit tools and resources in your lab environment.
157+
158+
1. Ensure that Python 3.11 or later is installed in your lab environment.
159+
160+
GitHub Spec Kit's CLI tool is Python-based and requires Python 3.11+.
161+
162+
To check the installed Python version, run the following command:
163+
164+
```powershell
165+
python --version
166+
```
167+
168+
Required output: **Python 3.11.0** or later.
169+
170+
If you need to install Python, you can download the installer from the following URL: [python.org](https://www.python.org/downloads/).
171+
172+
If you're in a corporate environment, you can also use your organization's software distribution system.
173+
174+
1. Ensure that the uv package manager is installed in your lab environment.
175+
176+
```powershell
177+
uv --version
178+
```
179+
180+
You should see output similar to the following sample:
181+
182+
```output
183+
uv 0.9.16 (a63e5b62e 2025-12-06)
184+
```
185+
186+
To install uv using Windows PowerShell, run the following command:
187+
188+
```powershell
189+
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
190+
```
191+
192+
GitHub Spec Kit uses uv for CLI installation and management.
193+
194+
You can find more installation instructions at the following URL: [docs.astral.sh/uv](https://docs.astral.sh/uv/)
195+
196+
1. To ensure that uv is in your environment PATH, restart your terminal window, and then run the following commands:
197+
198+
```powershell
199+
cd C:\
200+
uv --version
201+
```
202+
203+
You should see output similar to the following sample:
204+
205+
```output
206+
uv 0.9.17 (2b5d65e61 2025-12-09)
207+
```
208+
209+
1. Open a terminal window.
210+
211+
You can use a Command Prompt, PowerShell, or Terminal window.
212+
213+
1. To install GitHub Spec Kit's Specify CLI tool, run the following PowerShell command:
214+
215+
```powershell
216+
uv tool install specify-cli --from git+https://github.com/github/spec-kit.git
217+
```
218+
219+
This command installs the latest version directly from the GitHub repository and makes the *specify* command available system-wide.
220+
221+
The specify command-line tool is used to initialize projects for spec-driven development.
222+
223+
1. To ensure that the *specify* command is in your environment PATH, restart your terminal window, and then run the following command:
224+
225+
```powershell
226+
specify version
227+
```
228+
229+
After a short delay, you should see output that's similar to the following sample:
230+
231+
```output
232+
CLI Version 0.0.22
233+
Template Version 0.0.90
234+
Released 2025-12-04
235+
Python 3.14.0
236+
Platform Windows
237+
Architecture AMD64
238+
OS Version 10.0.26200
239+
```
240+
241+
Troubleshooting installation issues:
242+
243+
- Command not found: If the *specify* command isn't recognized after installation, the *uv* tools directory might not be in your PATH. To verify the installation, run *uv tool list* command. You might need to restart your terminal or manually add the tools directory to your PATH.
244+
245+
- In corporate environments with SSL interception, you might need to configure certificates. Contact your IT department for assistance.
246+
247+
Your GitHub Spec Kit development environment is now configured and ready.

0 commit comments

Comments
 (0)