Includes: Hosting integration only — Client integration not included

In this article, you learn about the Aspire Community Toolkit Node.js hosting extensions package which provides extra functionality to the AspireNodeJS hosting package. The extensions package brings the following features:

• RunningVite applications
• Running Node.js applications usingYarn andpnpm
• Ensuring that the packages are installed before running the application (using the specified package manager)

Hosting integration

To get started with the Aspire Community Toolkit Node.js hosting extensions, install the📦 CommunityToolkit.Aspire.Hosting.NodeJS.Extensions NuGet package in the AppHost project.

dotnet add package CommunityToolkit.Aspire.Hosting.NodeJS.Extensions

<PackageReference Include="CommunityToolkit.Aspire.Hosting.NodeJS.Extensions"                  Version="*" />

For more information, seedotnet add package orManage package dependencies in .NET applications.

Example usage

The following sections detail various usages, from running Vite applications to using specific package managers.

Run specific package managers

This integration extension adds support for running Node.js applications using Yarn or pnpm as the package manager.

var builder = DistributedApplication.CreateBuilder(args);builder.AddYarnApp("yarn-demo")       .WithExternalHttpEndpoints();

var builder = DistributedApplication.CreateBuilder(args);builder.AddPnpmApp("pnpm-demo")       .WithExternalHttpEndpoints();

Run Vite apps

This integration extension adds support for running the development server for Vite applications. By default, it uses thenpm package manager to launch, but this can be overridden with thepackageManager argument.

var builder = DistributedApplication.CreateBuilder(args);builder.AddViteApp("vite-demo")       .WithExternalHttpEndpoints();builder.AddViteApp("yarn-demo", packageManager: "yarn")       .WithExternalHttpEndpoints();builder.AddViteApp("pnpm-demo", packageManager: "pnpm")       .WithExternalHttpEndpoints();builder.Build().Run();

Install packages

When using theWithNpmPackageInstallation,WithYarnPackageInstallation orWithPnpmPackageInstallation methods, the package manager is used to install the packages before starting the application. These methods are useful to ensure that packages are installed before the application starts, similar to how a .NET application would restore NuGet packages before running.

See also

• Orchestrate Node.js apps in Aspire
• Aspire Community Toolkit GitHub repo
• Sample Node.js apps