9.1 KiB
title, shortTitle, intro, allowTitleToDifferFromFilename, redirect_from, versions, topics
| title | shortTitle | intro | allowTitleToDifferFromFilename | redirect_from | versions | topics | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Quickstart for GitHub Codespaces | Quickstart | Get started with {% data variables.product.prodname_github_codespaces %} quickly. | true |
|
|
|
{% ifversion ghec %}
{% data reusables.codespaces.data-residency-availability %}
{% endif %}
Introduction
In this guide, you'll create a codespace from a template repository and explore some of the essential features available to you within the codespace. You'll work in the browser version of {% data variables.product.prodname_vscode %}, which is initially the default editor for {% data variables.product.prodname_github_codespaces %}. After trying out this quickstart you can use {% data variables.product.prodname_codespaces %} in other editors, and you can change the default editor. Links are provided at the end of this guide.
From this quickstart, you'll learn how to create a codespace, connect to a forwarded port to view your running application, publish your codespace to a new repository, and personalize your setup with extensions.
For more information on exactly how {% data variables.product.prodname_github_codespaces %} works, see the companion guide AUTOTITLE.
Creating your codespace
- Navigate to the github/haikus-for-codespaces template repository. {% data reusables.codespaces.use-this-template %}
Running the application
Once your codespace is created, the template repository will be automatically cloned into it. Now you can run the application and launch it in a browser.
-
When the terminal becomes available, enter the command
npm run dev. This example uses a Node.js project, and this command runs the script labeled "dev" in thepackage.jsonfile, which starts up the web application defined in the sample repository.
If you're following along with a different application type, enter the corresponding start command for that project.
-
When your application starts, the codespace recognizes the port the application is running on and displays a pop-up message to let you know that the port has been forwarded.
-
Click Open in Browser to view your running application in a new tab.
Edit the application and view changes
-
Switch back to your codespace and open the
haikus.jsonfile by clicking it in the Explorer. -
Edit the
textfield of the first haiku to personalize the application with your own haiku. -
Go back to the running application tab in your browser and refresh to see your changes.
{% octicon "light-bulb" aria-hidden="true" aria-label="light-bulb" %} If you've closed the browser tab, click the Ports tab in {% data variables.product.prodname_vscode_shortname %}, hover over the Local Address value for the running port, and click the Open in Browser icon.
Committing and pushing your changes
Now that you've made a few changes, you can use the integrated terminal or the source view to publish your work to a new repository.
{% data reusables.codespaces.source-control-activity-bar %}
-
To stage your changes, click {% octicon "plus" aria-label="Stage Changes" %} next to the
haikus.jsonfile, or next to Changes if you've changed multiple files and you want to stage them all.
-
To commit your staged changes, type a commit message describing the change you've made, then click Commit.
-
Click Publish Branch.
-
In the "Repository Name" dropdown, type a name for your new repository, then select Publish to {% data variables.product.prodname_dotcom %} private repository or Publish to {% data variables.product.prodname_dotcom %} public repository.
The owner of the new repository will be the {% data variables.product.prodname_dotcom %} account with which you created the codespace.
-
In the pop-up that appears in the lower right corner of the editor, click Open on {% data variables.product.prodname_dotcom %} to view the new repository on {% data variables.product.github %}. In the new repository, view the
haikus.jsonfile and check that the change you made in your codespace has been successfully pushed to the repository.
Personalizing with an extension
When you connect to a codespace using the browser, or the {% data variables.product.prodname_vscode %} desktop application, you can access the {% data variables.product.prodname_vscode %} Marketplace directly from the editor. For this example, you'll install a {% data variables.product.prodname_vscode_shortname %} extension that alters the theme, but you can install any extension that's useful for your workflow.
-
In the Activity Bar, click the Extensions icon.
-
In the search bar, type
fairyflossand click Install.
-
Select the
fairyflosstheme by selecting it from the list.
About Settings Sync
You can enable Settings Sync to sync extensions and other settings across devices and instances of {% data variables.product.prodname_vscode_shortname %}. {% data reusables.codespaces.about-settings-sync %} For more information, see AUTOTITLE.
Next steps
You've successfully created, personalized, and run your first application within a codespace but there's so much more to explore! Here are some helpful resources for taking your next steps with {% data variables.product.prodname_github_codespaces %}.
- AUTOTITLE: This quickstart presented some of the features of {% data variables.product.prodname_github_codespaces %}. The deep dive looks at these areas from a technical standpoint.
- AUTOTITLE: These guides provide information on setting up your repository to use {% data variables.product.prodname_github_codespaces %} with specific languages.
- AUTOTITLE: This guide provides details on creating a custom configuration for {% data variables.product.prodname_codespaces %} for your project.