Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

microsoft/vscodespaces-quickstart

Repository files navigation

Visual Studio Codespaces Quickstart Sample

This is a sample project that supports the Visual Studio Codespaces quickstart documentation. It can be used for either the browser based quickstart or the Visual Studio Code based quickstart.

To make this file easier to read, press [ctrl]+[shift]+[V].

This repository has been cloned into your VS Codespaces cloud-hosted environment. You're able to work with it like you would any local code. Some things to try:

Terminal:

  1. Press Ctrl+Shift+backtick to open a new terminal.
  2. From the terminal run node --version.

    Note: Node.js may or may not be installed on your local machine, yet you're able to use it because it's been automatically added to this environment!

  3. Type other Linux commands (uname, ls, etc.) to interact with the underlying environment.

Browse Files:

  1. Notice that node_modules are in the File Explorer.

    Note: VS Codespaces automatically performed an npm install so you can be instantly productive!

  2. Open files to see syntax highlighting.

Edit code:

  1. Open server.js.

    Note: ESLint has been installed and configured in this environment. Press Ctrl+Shift+M (Cmd+Shift+M on macOS) to see the problems found by ESLint. Fix then by changing instances of var to const.

  2. Change the message to "Hello {your name} from VS Codespaces!" (on line 17).

Build, Run, and Debug:

  1. Add a breakpoint on line 21.
  2. Press F5 to launch the app.
  3. Once the breakpoint is hit, try hovering over variables, examining locals, and more.
  4. Press F5 to continue running the app.

Forward Port:

  1. Open the Remote Explorer activity pane.
  2. In the Codespace Details panel, click the Forward Port button that appears when you hover over Forwarded Ports (#)
    • Enter port 3000 in the prompt.
    • Accept the default name.
  3. Click the Copy Port URL button in the localhost:3000 title bar.
  4. Paste the URL into the browser of your choice.

    Note: VS Codespaces has forwarded the environment's port 3000 to a location you can now access.

Disconnect Environment:

  1. View the cloud-hosted codespaces in the Codespaces panel on the Remote Explorer.
  2. Right click on My Quick Codespace and select Disconnect.

About

A simple Node.js app to support Visual Studio Codespaces quickstart documentation.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published