Badgerati / Pode

Pode is a Cross-Platform PowerShell web framework for creating REST APIs, Web Sites, and TCP/SMTP servers
https://badgerati.github.io/Pode
MIT License
830 stars 92 forks source link

Add GitHub Codespace Configuration and Getting Started Guide for Pode #1342

Closed mdaneri closed 2 months ago

mdaneri commented 2 months ago

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

Additional Notes