Skip to content

Latest commit

 

History

History
60 lines (32 loc) · 2.74 KB

codespace.md

File metadata and controls

60 lines (32 loc) · 2.74 KB

Using GitHub Codespaces

What is GitHub Codespaces?

GitHub Codespaces is a cloud-based development environment that allows you to run your code directly from within GitHub. It provides a fully-featured, configurable, and on-demand development environment that can be accessed from anywhere. With GitHub Codespaces, you can:

  • Develop in a consistent environment across different machines.
  • Quickly start coding without setting up your local environment.
  • Use powerful cloud-based resources for development.

How to Spin Up a Codespace Instance

Follow these steps to spin up a Codespace instance using the devcontainer file:

Step 1: Navigate to Your Repository

  1. Go to your repository on GitHub. In this case, navigate to qldgov-sandbox/copilot-node-calculator.

Step 2: Open Codespaces

  1. Click on the Code button on the repository page.

image

  1. Select the Codespaces tab.

image

  1. Click on New codespace to create a new Codespace.

image

Step 3: Configure Your Codespace

  1. GitHub Codespaces will automatically detect the devcontainer.json file in your repository and use it to set up your development environment.

  2. Wait for the Codespace to start. This might take a few minutes as it sets up the environment according to the configurations specified in the devcontainer.json file.

Step 4: Start Coding

  1. Once the Codespace is ready, you will be taken to a VS Code-like interface in your browser. You can now start coding in the environment that has been set up according to your devcontainer.json file.

image

Step 5: Accessing Terminal and Other Features

  1. You can access the terminal by clicking on the menu and selecting View > Terminal.

image

  1. Use the terminal to run commands, install dependencies, and test your code.

Additional Tips

  • You can customize your development environment further by modifying the devcontainer.json file.
  • Codespaces supports extensions, themes, and other VS Code features, which you can install to enhance your development experience.

Conclusion

GitHub Codespaces provides a powerful and flexible development environment that you can access from anywhere. By following the steps above, you can quickly spin up a Codespace instance and start coding using the devcontainer.json file you created.