Skip to content

quickstart.md

Latest commit

 

History

History
151 lines (107 loc) · 4.46 KB

quickstart.md

File metadata and controls

151 lines (107 loc) · 4.46 KB
Raw

Quick Start

Get the spec2cloud Python shell running in under 5 minutes.

Prerequisites

Option A: Use Codespaces / DevContainer (Recommended)

All spec2cloud shells include a fully configured DevContainer / GitHub Codespaces setup. Everything is pre- the only thing you need locally is:installed

Then simply open the repo in VS Code and click "Reopen in Container", or launch a GitHub Codespace from the repo page. All prerequisites below are handled automatically.

Option B: Local Setup

If you prefer running locally without containers, install the following:

Core Tools (all shells need these)

Tool Purpose Install
GitHub Copilot AI orchestrator github.com/features/copilot
VS Code Editor with Copilot extension code.visualstudio.com
Azure CLI Azure resource management aka.ms/installcli
Azure Developer CLI (azd) Deploy to Azure Install azd
.NET SDK (latest) Required for Aspire orchestration dot.net
.NET Aspire Local service orchestration curl -sSL https://aspire.dev/install.sh | bash
Docker Container builds & deployment docker.com
Git Source control git-scm.com

Language-Specific (Python)

Optional (Recommended)

  • ** npx playwright install (for E2E tests)Playwright**
  • ** pip install mkdocs mkdocs-material (for documentation site)MkDocs**

Install Scripts

macOS (Homebrew) 
# Core tools
brew install azure-cli
brew install azd
brew install --cask docker
brew install dotnet
curl -sSL https://aspire.dev/install.sh | bash

# Language-specific
brew install python@3.11
curl -LsSf https://astral.sh/uv/install.sh | sh
brew install node@20

# Optional
npx playwright install-deps && npx playwright install
pip install mkdocs mkdocs-material
Linux (Ubuntu/Debian) 
# Core tools
curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash
curl -fsSL https://aka.ms/install-azd.sh | bash
wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh && chmod +x dotnet-install.sh && ./dotnet-install.sh
curl -sSL https://aspire.dev/install.sh | bash

# Language-specific
sudo apt-get install -y python3.11 python3.11-venv
curl -LsSf https://astral.sh/uv/install.sh | sh
curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
sudo apt-get install -y nodejs

# Optional
npx playwright install-deps && npx playwright install
pip install mkdocs mkdocs-material
Windows (winget / PowerShell) 
# Core tools
winget install Microsoft.AzureCLI
winget install Microsoft.Azd
winget install Microsoft.DotNet.SDK.Preview
winget install Docker.DockerDesktop
dotnet workload install aspire

# Language-specific
winget install Python.Python.3.11
winget install OpenJS.NodeJS.LTS

# Optional
npx playwright install
pip install mkdocs mkdocs-material

Verify Installation

# Core
az --version && azd version && dotnet --version && aspire --version && docker --version

# Language
python3 --version  # 3.11+
uv --version
node --version     # v20+

Getting Started

1. Clone and Run

git clone https://github.com/EmeaAppGbb/shell-python.git
cd shell-python
dotnet run --project apphost.cs    # Aspire starts all services

2. Open in VS Code with Copilot

The orchestrator (AGENTS.md) activates automatically when you start a Copilot conversation.

3. Start Building

deploy

  • Brownfield: Ask Copilot to analyze the existing it extracts specs, then you choose pathscodebase

What Happens Next

deploy) N increments

Phase 2 Delivery