From d28a1792683a90b3614faba04ffcac2e64c6d3b3 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 22 Nov 2025 02:30:33 +0000 Subject: [PATCH 1/8] Initial plan From 0fe5586b16e07c693a35ee66c27a042d9a54d762 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 22 Nov 2025 02:37:58 +0000 Subject: [PATCH 2/8] Add Setup and tooling section with Dev environment article Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --- src/frontend/sidebar.topics.ts | 81 ++++-- .../docs/get-started/dev-environment.mdx | 263 ++++++++++++++++++ 2 files changed, 326 insertions(+), 18 deletions(-) create mode 100644 src/frontend/src/content/docs/get-started/dev-environment.mdx diff --git a/src/frontend/sidebar.topics.ts b/src/frontend/sidebar.topics.ts index 90188390..c7780f47 100644 --- a/src/frontend/sidebar.topics.ts +++ b/src/frontend/sidebar.topics.ts @@ -85,26 +85,71 @@ export const sidebarTopics: StarlightSidebarTopicsUserConfig = [ }, items: [ { - label: 'Prerequisites', + label: 'Setup and tooling', translations: { - da: 'Forudsætninger', - de: 'Voraussetzungen', - en: 'Prerequisites', - es: 'Requisitos previos', - fr: 'Prérequis', - hi: 'पूर्वापेक्षाएँ', - id: 'Prasyarat', - it: 'Prerequisiti', - ja: '前提条件', - ko: '전제 조건', - 'pt-BR': 'Pré-requisitos', - 'pt-PT': 'Pré-requisitos', - ru: 'Предварительные требования', - tr: 'Ön koşullar', - uk: 'Попередні вимоги', - 'zh-CN': '先决条件', + da: 'Opsætning og værktøjer', + de: 'Einrichtung und Werkzeuge', + en: 'Setup and tooling', + es: 'Configuración y herramientas', + fr: 'Configuration et outils', + hi: 'सेटअप और टूलिंग', + id: 'Pengaturan dan alat', + it: 'Configurazione e strumenti', + ja: 'セットアップとツール', + ko: '설정 및 도구', + 'pt-BR': 'Configuração e ferramentas', + 'pt-PT': 'Configuração e ferramentas', + ru: 'Настройка и инструменты', + tr: 'Kurulum ve araçlar', + uk: 'Налаштування та інструменти', + 'zh-CN': '设置和工具', }, - slug: 'get-started/prerequisites' + items: [ + { + label: 'Prerequisites', + translations: { + da: 'Forudsætninger', + de: 'Voraussetzungen', + en: 'Prerequisites', + es: 'Requisitos previos', + fr: 'Prérequis', + hi: 'पूर्वापेक्षाएँ', + id: 'Prasyarat', + it: 'Prerequisiti', + ja: '前提条件', + ko: '전제 조건', + 'pt-BR': 'Pré-requisitos', + 'pt-PT': 'Pré-requisitos', + ru: 'Предварительные требования', + tr: 'Ön koşullar', + uk: 'Попередні вимоги', + 'zh-CN': '先决条件', + }, + slug: 'get-started/prerequisites' + }, + { + label: 'Dev environment', + translations: { + da: 'Udviklingsmiljø', + de: 'Entwicklungsumgebung', + en: 'Dev environment', + es: 'Entorno de desarrollo', + fr: 'Environnement de développement', + hi: 'डेव वातावरण', + id: 'Lingkungan pengembangan', + it: 'Ambiente di sviluppo', + ja: '開発環境', + ko: '개발 환경', + 'pt-BR': 'Ambiente de desenvolvimento', + 'pt-PT': 'Ambiente de desenvolvimento', + ru: 'Среда разработки', + tr: 'Geliştirme ortamı', + uk: 'Середовище розробки', + 'zh-CN': '开发环境', + }, + slug: 'get-started/dev-environment' + }, + ] }, { label: 'Install CLI', diff --git a/src/frontend/src/content/docs/get-started/dev-environment.mdx b/src/frontend/src/content/docs/get-started/dev-environment.mdx new file mode 100644 index 00000000..9f5c75db --- /dev/null +++ b/src/frontend/src/content/docs/get-started/dev-environment.mdx @@ -0,0 +1,263 @@ +--- +title: Dev environment +description: Learn about different development environments and IDEs for Aspire. +giscus: false +tableOfContents: + minHeadingLevel: 1 + maxHeadingLevel: 4 +lastUpdated: true +prev: false +--- + +import { Aside, Icon, Code, CardGrid, Card, LinkCard, LinkButton, Steps, Tabs, TabItem } from '@astrojs/starlight/components'; +import IconAside from '@components/IconAside.astro'; +import IconLinkCard from '@components/IconLinkCard.astro'; +import PivotSelector from '@components/PivotSelector.astro'; +import Pivot from '@components/Pivot.astro'; + +Aspire supports multiple integrated development environments (IDEs) and code editors. Choose the environment that best fits your workflow and platform. + + + + + +## Visual Studio Code + +[Visual Studio Code](https://code.visualstudio.com/) is a lightweight, cross-platform code editor that works on Windows, macOS, and Linux. It provides excellent support for .NET development and Aspire applications. + +### Install Visual Studio Code + +1. Download and install [Visual Studio Code](https://code.visualstudio.com/download) for your platform. + +### Required extensions + +Install the following extensions to work with Aspire in Visual Studio Code: + +#### C# Dev Kit + +The [C# Dev Kit extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) provides comprehensive C# language support, including: + +- IntelliSense for code completion +- Debugging capabilities +- Project management +- Testing integration + +To install: +1. Open Visual Studio Code +2. Go to the Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X` on macOS) +3. Search for "C# Dev Kit" +4. Click **Install** + +#### Aspire extension + +The [Aspire extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.aspire) provides Aspire-specific features: + +- **Run and debug** Aspire applications directly from VS Code +- **Dashboard integration** to view and manage your application resources +- **IntelliSense** for Aspire APIs and configuration +- **Project templates** for creating new Aspire applications +- **Code snippets** for common Aspire patterns + +To install: +1. Open Visual Studio Code +2. Go to the Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X` on macOS) +3. Search for "Aspire" +4. Click **Install** + +### Working with Aspire in VS Code + +Once you have the extensions installed: + +1. Open your Aspire solution folder in Visual Studio Code +2. The Aspire extension will detect your AppHost project +3. Use the **Run and Debug** panel to start your application +4. The Aspire dashboard will open automatically in your browser +5. Set breakpoints and debug your services as needed + + + + + + + +## Visual Studio + +[Visual Studio](https://visualstudio.microsoft.com/vs/) is a comprehensive IDE for Windows and macOS that provides full-featured development tools for .NET applications. + +### Install Visual Studio + +1. Download [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) (version 17.9 or later recommended) +2. During installation, select the **ASP.NET and web development** workload +3. Ensure the **.NET Aspire SDK** component is selected (included in the workload) + +### Visual Studio Features for Aspire + +Visual Studio provides integrated support for Aspire development: + +- **Project templates** for creating Aspire applications +- **Solution Explorer** integration for managing Aspire projects +- **Debugging** with full breakpoint and diagnostic support +- **Dashboard integration** that launches automatically when you run an AppHost +- **IntelliSense** for Aspire APIs +- **NuGet package management** for Aspire integrations +- **Docker integration** for container management + +### Working with Aspire in Visual Studio + +1. Create a new Aspire application: + - Go to **File** > **New** > **Project** + - Search for ".NET Aspire" + - Select **.NET Aspire Starter Application** or **.NET Aspire Empty App** + - Configure your project settings and click **Create** + +2. Run your application: + - Press **F5** or click the **Start** button + - The Aspire dashboard opens automatically + - All configured services start and are visible in the dashboard + +3. Debug your services: + - Set breakpoints in your service code + - The debugger attaches to all .NET projects automatically + - Use the Debug toolbar to step through code and inspect variables + + + + + + + +## JetBrains Rider + +[JetBrains Rider](https://www.jetbrains.com/rider/) is a powerful, cross-platform IDE for .NET development available on Windows, macOS, and Linux. + +### Install JetBrains Rider + +1. Download and install [JetBrains Rider](https://www.jetbrains.com/rider/download/) +2. Ensure you have at least Rider 2024.1 or later for best Aspire support + +### Aspire Plugin for Rider + +Install the [.NET Aspire plugin](https://plugins.jetbrains.com/plugin/23289--net-aspire) to get enhanced Aspire support: + +1. Open Rider +2. Go to **File** > **Settings** (or **Rider** > **Preferences** on macOS) +3. Navigate to **Plugins** +4. Search for ".NET Aspire" +5. Click **Install** +6. Restart Rider + +### Features + +The .NET Aspire plugin provides: + +- **Run configurations** for AppHost projects +- **Dashboard integration** that launches when running an AppHost +- **Project templates** for creating Aspire applications +- **Code completion** for Aspire APIs +- **Debugging support** for Aspire services +- **Resource monitoring** in the IDE + +### Working with Aspire in Rider + +1. Open your Aspire solution in Rider +2. The IDE automatically detects the AppHost project +3. Select the AppHost project in the run configurations dropdown +4. Click the **Run** or **Debug** button +5. The Aspire dashboard opens automatically + + + + + + + +## Aspire CLI + +The [Aspire CLI](/get-started/install-cli/) provides command-line tools for creating, running, and managing Aspire applications without an IDE. This is ideal for: + +- **CI/CD pipelines** and automated workflows +- **Container-based development** environments +- **Lightweight development** without a full IDE +- **Script-based** automation and tooling + +### Installation + +Follow the [Install CLI guide](/get-started/install-cli/) to install the Aspire CLI for your platform. + +### Key Commands + +Once installed, you can use these commands to work with Aspire: + +#### Create a new application + +```bash +aspire new starter --name MyApp +``` + +Creates a new Aspire starter application with an AppHost, a web frontend, and an API service. + +#### Run your application + +```bash +aspire run +``` + +Starts your Aspire application and opens the dashboard in your browser. + +#### Add integrations + +```bash +aspire add +``` + +Interactively adds Aspire integrations (databases, caches, message queues, etc.) to your project. + +#### Deploy your application + +```bash +aspire deploy +``` + +Deploys your Aspire application to a cloud provider (Azure Container Apps, Kubernetes, etc.). + +### Using the CLI with editors + +The Aspire CLI works well with any text editor: + +- **Vim/Neovim** - Use with LSP for .NET support +- **Emacs** - Configure with omnisharp for C# editing +- **Sublime Text** - Install C# packages for syntax highlighting +- **Any editor** - Use the CLI for building and running, your editor for code changes + + + + + +## Next steps + +After setting up your development environment: + +1. Complete the [Prerequisites](/get-started/prerequisites/) to ensure all required tools are installed +2. [Build your first Aspire app](/get-started/first-app/) to learn the basics +3. Explore the [Aspire dashboard](/dashboard/overview/) to monitor and manage your applications + + From fee49dc50285071bed4f4278619fd405a9e8a680 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 22 Nov 2025 02:40:30 +0000 Subject: [PATCH 3/8] Address code review feedback - update VS version and remove outdated references Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --- .../src/content/docs/get-started/dev-environment.mdx | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/src/frontend/src/content/docs/get-started/dev-environment.mdx b/src/frontend/src/content/docs/get-started/dev-environment.mdx index 9f5c75db..7734c8f1 100644 --- a/src/frontend/src/content/docs/get-started/dev-environment.mdx +++ b/src/frontend/src/content/docs/get-started/dev-environment.mdx @@ -97,7 +97,7 @@ The Aspire extension provides commands accessible via the Command Palette (`Ctrl ### Install Visual Studio -1. Download [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) (version 17.9 or later recommended) +1. Download [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) (version 17.10 or later recommended) 2. During installation, select the **ASP.NET and web development** workload 3. Ensure the **.NET Aspire SDK** component is selected (included in the workload) @@ -132,7 +132,7 @@ Visual Studio provides integrated support for Aspire development: - Use the Debug toolbar to step through code and inspect variables @@ -257,7 +257,3 @@ After setting up your development environment: 1. Complete the [Prerequisites](/get-started/prerequisites/) to ensure all required tools are installed 2. [Build your first Aspire app](/get-started/first-app/) to learn the basics 3. Explore the [Aspire dashboard](/dashboard/overview/) to monitor and manage your applications - - From ebcba151a7c92214cfcf699d61fdb8478ffe6f61 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Sat, 22 Nov 2025 13:27:13 +0000 Subject: [PATCH 4/8] Address PR feedback - move headings outside Pivot, use Kbd and Steps components Co-authored-by: IEvangelist <7679720+IEvangelist@users.noreply.github.com> --- .../docs/get-started/dev-environment.mdx | 139 +++++++++++++++--- 1 file changed, 117 insertions(+), 22 deletions(-) diff --git a/src/frontend/src/content/docs/get-started/dev-environment.mdx b/src/frontend/src/content/docs/get-started/dev-environment.mdx index 7734c8f1..0b859c0b 100644 --- a/src/frontend/src/content/docs/get-started/dev-environment.mdx +++ b/src/frontend/src/content/docs/get-started/dev-environment.mdx @@ -1,15 +1,12 @@ --- title: Dev environment description: Learn about different development environments and IDEs for Aspire. -giscus: false -tableOfContents: - minHeadingLevel: 1 - maxHeadingLevel: 4 lastUpdated: true prev: false --- import { Aside, Icon, Code, CardGrid, Card, LinkCard, LinkButton, Steps, Tabs, TabItem } from '@astrojs/starlight/components'; +import { Kbd } from 'starlight-kbd/components' import IconAside from '@components/IconAside.astro'; import IconLinkCard from '@components/IconLinkCard.astro'; import PivotSelector from '@components/PivotSelector.astro'; @@ -28,22 +25,36 @@ Aspire supports multiple integrated development environments (IDEs) and code edi ]} /> +## Visual Studio Code + -## Visual Studio Code +[Visual Studio Code](https://code.visualstudio.com/) is a lightweight, cross-platform code editor that works on Windows, macOS, and Linux. It provides excellent support for C# development and Aspire applications. -[Visual Studio Code](https://code.visualstudio.com/) is a lightweight, cross-platform code editor that works on Windows, macOS, and Linux. It provides excellent support for .NET development and Aspire applications. + ### Install Visual Studio Code + + + 1. Download and install [Visual Studio Code](https://code.visualstudio.com/download) for your platform. + + + ### Required extensions + + Install the following extensions to work with Aspire in Visual Studio Code: + + #### C# Dev Kit + + The [C# Dev Kit extension](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.csdevkit) provides comprehensive C# language support, including: - IntelliSense for code completion @@ -52,13 +63,20 @@ The [C# Dev Kit extension](https://marketplace.visualstudio.com/items?itemName=m - Testing integration To install: + + 1. Open Visual Studio Code -2. Go to the Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X` on macOS) +2. Go to the Extensions view () 3. Search for "C# Dev Kit" 4. Click **Install** + + + #### Aspire extension + + The [Aspire extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-dotnettools.aspire) provides Aspire-specific features: - **Run and debug** Aspire applications directly from VS Code @@ -68,41 +86,60 @@ The [Aspire extension for Visual Studio Code](https://marketplace.visualstudio.c - **Code snippets** for common Aspire patterns To install: + + 1. Open Visual Studio Code -2. Go to the Extensions view (`Ctrl+Shift+X` or `Cmd+Shift+X` on macOS) +2. Go to the Extensions view () 3. Search for "Aspire" 4. Click **Install** + + + ### Working with Aspire in VS Code + + Once you have the extensions installed: + 1. Open your Aspire solution folder in Visual Studio Code 2. The Aspire extension will detect your AppHost project 3. Use the **Run and Debug** panel to start your application 4. The Aspire dashboard will open automatically in your browser 5. Set breakpoints and debug your services as needed + - - ## Visual Studio + + [Visual Studio](https://visualstudio.microsoft.com/vs/) is a comprehensive IDE for Windows and macOS that provides full-featured development tools for .NET applications. + + ### Install Visual Studio + + + 1. Download [Visual Studio 2022](https://visualstudio.microsoft.com/downloads/) (version 17.10 or later recommended) 2. During installation, select the **ASP.NET and web development** workload -3. Ensure the **.NET Aspire SDK** component is selected (included in the workload) +3. Ensure the **Aspire SDK** component is selected (included in the workload) + + + ### Visual Studio Features for Aspire + + Visual Studio provides integrated support for Aspire development: - **Project templates** for creating Aspire applications @@ -113,16 +150,21 @@ Visual Studio provides integrated support for Aspire development: - **NuGet package management** for Aspire integrations - **Docker integration** for container management + + ### Working with Aspire in Visual Studio + + + 1. Create a new Aspire application: - Go to **File** > **New** > **Project** - - Search for ".NET Aspire" - - Select **.NET Aspire Starter Application** or **.NET Aspire Empty App** + - Search for "Aspire" + - Select **Aspire Starter Application** or **Aspire Empty App** - Configure your project settings and click **Create** 2. Run your application: - - Press **F5** or click the **Start** button + - Press or click the **Start** button - The Aspire dashboard opens automatically - All configured services start and are visible in the dashboard @@ -130,6 +172,7 @@ Visual Studio provides integrated support for Aspire development: - Set breakpoints in your service code - The debugger attaches to all .NET projects automatically - Use the Debug toolbar to step through code and inspect variables +