| ← Getting started with GitHub Copilot | Next: Coding with GitHub Copilot → |
|---|
To complete this workshop you will need to create a repository with a copy of the contents of this repository. While this can be done by forking a repository, the goal of a fork is to eventually merge code back into the original (or upstream) source. In our case we want a separate copy as we don't intend to merge our changes. This is accomplished through the use of a template repository. Template repositories are a great way to provide starters for your organization, ensuring consistency across projects.
The repository for this workshop is configured as a template, so we can use it to create your repository.
Important
Ensure you have the requisite software and requisite resources setup.
Let's create the repository you'll use for your workshop.
-
Navigate to the repository root
-
Select Use this template > Create a new repository
-
Under Owner, select the name of your GitHub handle, or the owner specified by your workshop leader.
-
Under Repository, set the name to pets-workshop, or the name specified by your workshop leader.
-
Ensure Public is selected for the visibility, or the value indicated by your workshop leader.
-
Select Create repository from template.
In a few moments a new repository will be created from the template for this workshop!
With the repository created, it's now time to clone the repository locally. We'll do this from a shell capable of running BASH commands.
-
Copy the URL for the repository you just created in the prior set.
-
Open your terminal or command shell.
-
Run the following command to clone the repository locally (changing directories to a parent directory as appropriate):
git clone <INSERT_REPO_URL_HERE>
-
Change directories into the cloned repository by running the following command:
cd <REPO_NAME_HERE>
-
Start the application by running the script appropriate for your operating system:
-
macOS / Linux:
./scripts/start-app.sh
-
Windows (PowerShell):
./scripts/start-app.ps1
If you encounter execution policy warnings on Windows, run PowerShell as an administrator or execute the script with an explicit bypass, for example:
powershell -ExecutionPolicy Bypass -File .\scripts\start-app.ps1
-
The startup script will start two applications:
- The backend Flask app on localhost:5100. You can see a list of dogs by opening the dogs API.
- The frontend Astro/Svelte app on localhost:4321. You can see the website by opening that URL.
With the code cloned locally, and the site running, let's open the codebase up in VS Code.
- Open VS Code.
- Select File > Open Folder.
- Navigate to the folder which contains the project you cloned earlier in this exercise.
- With the folder highlighted, select Open folder.
You've now cloned the repository you'll use for this workshop and have your IDE setup! Next let's add a new endpoint to the server!
| ← Getting started with GitHub Copilot | Next: Coding with GitHub Copilot → |
|---|