GitHub - terle/aspire-neo4j: Unofficial neo4j integration for dotnet Aspire, developed by Northern Nerds.

2 min read Original article ↗

Neo4j Aspire Integration (Unofficial)

Build Status

This repository provides unofficial Neo4j integrations for .NET Aspire.

Packages

Package Version Downloads
NorthernNerds.Aspire.Neo4j NuGet Downloads
NorthernNerds.Aspire.Hosting.Neo4j NuGet Downloads

Getting Started

Installation

# Install both packages
dotnet add package NorthernNerds.Aspire.Hosting.Neo4j
dotnet add package NorthernNerds.Aspire.Neo4j

Usage

In your AppHost project:

using NorthernNerds.Aspire.Hosting.Neo4j;

var builder = DistributedApplication.CreateBuilder(args);
var neo4jDb = builder.AddNeo4j("graph-db", neo4jUser, neo4jPass);

In your service projects:

using NorthernNerds.Aspire.Neo4j;

var builder = WebApplication.CreateBuilder(args);
builder.AddNeo4jClient("graph-db");

For more details, check the:

Documentation

  • Release Guide: Instructions on how to release a new version of the package.

Contributing

Contributions are welcome! Please see the CONTRIBUTING.md for details on how to contribute.

License

This project is licensed under the MIT License.

About Northern Nerds

Northern Nerds is a one-man freelance software company dedicated to creating high-quality software solutions and tools. Follow our work to stay updated on the latest projects and contributions.

Release notes

3.0.0 (since v2.0.0)

NorthernNerds.Aspire.Neo4j (Client)

  • Upgraded to .NET 10 and .NET Aspire 13.1
  • Added health checks (enabled by default; configurable via Neo4jClientSettings.DisableHealthChecks)
  • Improved DI registration to support multiple connections (singleton/keyed singleton)

NorthernNerds.Aspire.Hosting.Neo4j (Hosting)

  • Upgraded to .NET 10 and .NET Aspire 13.1
  • Enhanced AddNeo4j hosting integration ([ResourceName], nullable ports, improved NEO4J_AUTH handling, endpoint refactor)
  • Example updated to wait for Neo4j readiness