Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/communitytoolkit/aspire

A community project with additional components and extensions for .NET Aspire
https://github.com/communitytoolkit/aspire
aspire dotnet
Last synced: 2 days ago
JSON representation
A community project with additional components and extensions for .NET Aspire
Host: GitHub
URL: https://github.com/communitytoolkit/aspire
Owner: CommunityToolkit
License: mit
Created: 2024-07-04T18:06:28.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-11-11T07:38:25.000Z (4 days ago)
Last Synced: 2024-11-11T07:46:34.876Z (4 days ago)
Topics: aspire, dotnet
Language: C#
Homepage:
Size: 19.4 MB
Stars: 81
Watchers: 12
Forks: 8
Open Issues: 21
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project

README

        [](https://dotnetfoundation.org)

# .NET Aspire Community Toolkit

[![CI](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-ci.yml/badge.svg)](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-ci.yml) | [![main branch](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-main.yml/badge.svg)](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-main.yml) | [![Latest Release](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-release.yml/badge.svg)](https://github.com/CommunityToolkit/Aspire/actions/workflows/dotnet-release.yml)

The .NET Aspire Community Toolkit is a collection of integrations and extensions for developing with .NET Aspire.

All features are contributed by you, our amazing .NET community, and maintained by a core set of maintainers. Check out our [FAQ](./docs/faq.md) for more information.

## 👀 What does this repo contain?

This repository contains the source code for the .NET Aspire Community Toolkit, a collection of community created Integrations and extensions for [.NET Aspire](https://aka.ms/dotnet/aspire).

| Package                                                                                                                                                                                                                                                                                                                 | Description                                                                                                                                                                                                                    |

| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

| - **Learn More**: [`Hosting.Azure.StaticWebApps`][swa-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Azure.StaticWebApps][swa-shields]][swa-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Azure.StaticWebApps][swa-shields-preview]][swa-nuget-preview]                      | A hosting integration for the [Azure Static Web Apps emulator](https://learn.microsoft.com/azure/static-web-apps/static-web-apps-cli-overview) (Note: this does not support deployment of a project to Azure Static Web Apps). |

| - **Learn More**: [`Hosting.Golang`][golang-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Golang][golang-shields]][golang-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Golang][golang-shields-preview]][golang-nuget-preview]                                              | A hosting integration Golang apps.                                                                                                                                                                                             |

| **Learn More**: [`Hosting.Java`][java-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Java][java-shields]][java-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Java][java-shields-preview]][java-nuget-preview]                                                                | A integration for running Java code in .NET Aspire either using the local JDK or using a container.                                                                                                                            |

| - **Learn More**: [`Hosting.NodeJS.Extensions`][nodejs-ext-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.NodeJS.Extensions][nodejs-ext-shields]][nodejs-ext-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Hosting.NodeJS.Extensions][nodejs-ext-shields-preview]][nodejs-ext-nuget-preview] | An integration that contains some additional extensions for running Node.js applications                                                                                                                                       |

| - **Learn More**: [`Hosting.Ollama`][ollama-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Ollama][ollama-shields]][ollama-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Ollama][ollama-shields-preview]][ollama-nuget-preview]                                              | An Aspire hosting integration leveraging the [Ollama](https://ollama.com) container with support for downloading a model on startup.                                                                                           |

| - **Learn More**: [`OllamaSharp`][ollama-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.OllamaSharp][ollamasharp-shields]][ollamasharp-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.OllamaSharp][ollamasharp-shields-preview]][ollama-nuget-preview]                                        | An Aspire client integration for the [OllamaSharp](https://github.com/awaescher/OllamaSharp) package.                                                                                                                          |

| - **Learn More**: [`Hosting.Meilisearch`][meilisearch-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Meilisearch][meilisearch-shields]][meilisearch-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Meilisearch][meilisearch-shields-preview]][meilisearch-nuget-preview]      | An Aspire hosting integration leveraging the [Meilisearch](https://meilisearch.com) container.                                                                                                                                 |

| - **Learn More**: [`Meilisearch`][meilisearch-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.Meilisearch][meilisearch-client-shields]][meilisearch-client-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Meilisearch][meilisearch-client-shields-preview]][meilisearch-client-nuget-preview]  | An Aspire client integration for the [Meilisearch](https://github.com/meilisearch/meilisearch-dotnet) package.                                                                                                                 |

| - **Learn More**: [`Hosting.Azure.DataApiBuilder`][dab-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder][dab-shields]][dab-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder][dab-shields-preview]][dab-nuget-preview]                   | A hosting integration for the [Azure Data API builder](https://learn.microsoft.com/en-us/azure/data-api-builder/overview).                                                                       |

| - **Learn More**: [`Hosting.Deno`][deno-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Deno][deno-shields]][deno-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Deno][deno-shields-preview]][deno-nuget-preview]                                                              | A hosting integration for the Deno apps.                                                                       |

| - **Learn More**: [`Hosting.SqlDatabaseProjects`][sql-database-projects-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects][sql-database-projects-shields]][sql-database-projects-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects][sql-database-projects-shields-preview]][sql-database-projects-nuget-preview]                 | A hosting integration for the SQL Databases Projects.                                                                       |

| - **Learn More**: [`Hosting.Rust`][rust-integration-docs] 
 - Stable 📦: [![CommunityToolkit.Aspire.Hosting.Rust][rust-shields]][rust-nuget] 
 - Preview 📦: [![CommunityToolkit.Aspire.Hosting.Rust][rust-shields-preview]][rust-nuget-preview]                                                              | A hosting integration for the Rust apps.                                                                       |

## 🙌 Getting Started

Each of the integrations in the toolkit is available as a NuGet package, and can be added to your .NET project. Refer to the table above for the available integrations and the documentation on how to use them.

### 📦 Installation

Stable releases of the NuGet packages will be published to the [NuGet Gallery](https://www.nuget.org/packages?q=CommunityToolkit.Aspire). For pre-release versions, you can use Azure Artifacts feeds:

-   [View latest `main` branch packages](https://dev.azure.com/dotnet/CommunityToolkit/_packaging?_a=feed&feed=CommunityToolkit-MainLatest)

    -   [Feed URL](https://pkgs.dev.azure.com/dotnet/CommunityToolkit/_packaging/CommunityToolkit-MainLatest/nuget/v3/index.json)

-   [View latest PR build packages](https://dev.azure.com/dotnet/CommunityToolkit/_packaging?_a=feed&feed=CommunityToolkit-PullRequests)

    -   [Feed URL](https://pkgs.dev.azure.com/dotnet/CommunityToolkit/_packaging/CommunityToolkit-PullRequests/nuget/v3/index.json)

_Stable releases are not published to the Azure Artifacts feeds, they can only be accessed from the NuGet Gallery._

## 📃 Documentation

Documentation for the .NET Aspire Community Toolkit is available on the [Microsoft Docs](https://learn.microsoft.com/dotnet/aspire/community-toolkit/overview).

## 🚀 Contribution

Do you want to contribute?

Check out our [Contributing guide](./CONTRIBUTING.md) to learn more about contribution and guidelines!

## 🏆 Contributors

[![Toolkit Contributors](https://contrib.rocks/image?repo=CommunityToolkit/Aspire)](https://github.com/CommunityToolkit/Aspire/graphs/contributors)

Made with [contrib.rocks](https://contrib.rocks).

## Code of Conduct

As a part of the .NET Foundation, we have adopted the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). Please familiarize yourself with that before participating with this repository. Thanks!

## .NET Foundation

This project is supported by the [.NET Foundation](https://dotnetfoundation.org).

[swa-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-azure-static-web-apps

[swa-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.Azure.StaticWebApps

[swa-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Azure.StaticWebApps/

[swa-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.Azure.StaticWebApps?label=nuget%20(preview)

[swa-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Azure.StaticWebApps/absoluteLatest

[golang-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-golang

[golang-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.Golang

[golang-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Golang/

[golang-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.Golang?label=nuget%20(preview)

[golang-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Golang/absoluteLatest

[java-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-java

[java-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.Java

[java-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Java/

[java-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.Java?label=nuget%20(preview)

[java-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Java/absoluteLatest

[nodejs-ext-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-nodejs-extensions

[nodejs-ext-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions

[nodejs-ext-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions/

[nodejs-ext-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions?label=nuget%20(preview)

[nodejs-ext-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.NodeJS.Extensions/absoluteLatest

[ollama-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-ollama

[ollama-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.Ollama

[ollama-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Ollama/

[ollama-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.Ollama?label=nuget%20(preview)

[ollama-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Ollama/absoluteLatest

[ollamasharp-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.OllamaSharp

[ollamasharp-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.OllamaSharp/

[ollamasharp-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.OllamaSharp?label=nuget%20(preview)

[ollamasharp-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.OllamaSharp/absoluteLatest

[meilisearch-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-meilisearch

[meilisearch-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.Meilisearch

[meilisearch-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Meilisearch/

[meilisearch-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.Meilisearch?label=nuget%20(preview)

[meilisearch-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Meilisearch/absoluteLatest

[meilisearch-client-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Meilisearch

[meilisearch-client-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Meilisearch/

[meilisearch-client-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Meilisearch?label=nuget%20(preview)

[meilisearch-client-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Meilisearch/absoluteLatest

[dab-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-data-api-builder

[dab-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder

[dab-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder/

[dab-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder?label=nuget%20(preview)

[dab-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Azure.DataApiBuilder/absoluteLatest

[deno-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-deno

[deno-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.Deno

[deno-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Deno/

[deno-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.Deno?label=nuget%20(preview)

[deno-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Deno/absoluteLatest

[sql-database-projects-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-sql-database-projects

[sql-database-projects-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects

[sql-database-projects-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects/

[sql-database-projects-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects?label=nuget%20(preview)

[sql-database-projects-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.SqlDatabaseProjects/absoluteLatest

[rust-integration-docs]: https://learn.microsoft.com/dotnet/aspire/community-toolkit/hosting-rust

[rust-shields]: https://img.shields.io/nuget/v/CommunityToolkit.Aspire.Hosting.Rust

[rust-nuget]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Rust/

[rust-shields-preview]: https://img.shields.io/nuget/vpre/CommunityToolkit.Aspire.Hosting.Rust?label=nuget%20(preview)

[rust-nuget-preview]: https://nuget.org/packages/CommunityToolkit.Aspire.Hosting.Rust/absoluteLatest