Pode icon indicating copy to clipboard operation
Pode copied to clipboard

Add GitHub Codespace Configuration and Getting Started Guide for Pode

Open mdaneri opened this issue 7 months ago • 0 comments

Description

This PR introduces a GitHub Codespace configuration for Pode development and an accompanying "Getting Started with GitHub Codespace and Pode" guide. The updates aim to streamline the development setup process and provide clear instructions for using Pode within a GitHub Codespace environment.

Changes

  1. Add devcontainer.json Configuration:

    • Name: Codespace with PowerShell, Pester, Invoke-Build, and .NET 8
    • Image: Uses the base Ubuntu image from the VS Code devcontainers repository
    • Features:
      • PowerShell
      • .NET 8 SDK
    • Customizations:
      • Installs the PowerShell and Pester Test VS Code extensions
    • Post Create Command:
      • Installs the InvokeBuild module using PowerShell
    {
      "name": "Codespace with PowerShell, Pester, Invoke-Build, and .NET 8",
      "image": "mcr.microsoft.com/vscode/devcontainers/base:ubuntu",
      "features": {
        "ghcr.io/devcontainers/features/powershell:1": {},
        "ghcr.io/devcontainers/features/dotnet:1": {
          "version": "8.0"
        }
      },
      "customizations": {
        "vscode": {
          "extensions": [
            "ms-vscode.powershell",
            "pspester.pester-test"
          ]
        }
      },
      "postCreateCommand": "pwsh -Command 'Install-Module -Name InvokeBuild -Force -SkipPublisherCheck'"
    }
    
  2. Add Getting Started Guide:

    • A new Markdown file GitHubCodespace.md has been added to the documentation.
    • The guide includes:
      • Instructions for opening and initializing a GitHub Codespace using the provided devcontainer.json.
      • Steps to verify the setup by checking installed PowerShell modules.
      • Instructions to run a Pode application using the HelloWorld.ps1 example from the examples folder.
      • Tips for using the run/debug feature in Visual Studio Code.
      • Guidance on accessing the running Pode application through the forwarded port provided by GitHub Codespaces.

Benefits

  • Simplifies the development setup for Pode by leveraging GitHub Codespaces.
  • Provides a pre-configured development environment with all necessary tools and extensions installed.
  • Enhances the Pode documentation with clear, step-by-step instructions for new and existing users.

Additional Notes

  • The HelloWorld.ps1 script example provided in the guide serves as a basic starting point for users new to Pode.
  • The guide leverages the existing devcontainer.json file in the repository for environment setup, ensuring consistency and ease of use.

mdaneri avatar Jun 27 '24 05:06 mdaneri