Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/terle/aspire-neo4j
Unofficial Aspire component for integrating Neo4j, developed by Northern Nerds.
https://github.com/terle/aspire-neo4j
aspire aspire-component aspire-hosting neo4j neo4j-driver open-source
Last synced: 3 months ago
JSON representation
Unofficial Aspire component for integrating Neo4j, developed by Northern Nerds.
- Host: GitHub
- URL: https://github.com/terle/aspire-neo4j
- Owner: terle
- License: mit
- Created: 2024-08-25T11:55:08.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T15:04:43.000Z (4 months ago)
- Last Synced: 2024-09-27T21:41:20.116Z (3 months ago)
- Topics: aspire, aspire-component, aspire-hosting, neo4j, neo4j-driver, open-source
- Language: C#
- Homepage: https://northern-nerds.dk/
- Size: 165 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# NorthernNerds.Aspire.Neo4
**NorthernNerds.Aspire.Neo4** is an **unofficial** Aspire component for integrating Neo4j into [dotnet Aspire](https://learn.microsoft.com/en-us/dotnet/aspire/get-started/aspire-overview). This package simplifies working with Neo4j within Aspire-based applications by creating a Neo4j container and injecting an `IDriver` in the DI from the officially supported [.Net driver](https://neo4j.com/docs/getting-started/languages-guides/neo4j-dotnet/) by Neo4j.
## Features
- Seamless integration of Neo4j with Aspire.
- Supports adding Neo4j as a resource and injecting `IDriver` into your services.
- Simple setup for local development with easy configuration using `appsettings.json`.
## Why This Package?
This package is my first contribution to the developer community. I created it because I needed an easy way to integrate Neo4j with the Aspire framework, and I wanted to share this solution with others who might have similar needs.
I believe in the potential of Aspire and love working with graph databases. By sharing this package, I hope to make it easier for other developers to include Neo4j in their projects, and to contribute to the growth of the Aspire ecosystem.
If you find this package useful, I would love to hear from you. Contributions, suggestions, and feedback are always welcome!
Let's build something great together!
## Installation
You can install this package via NuGet:
```bash
dotnet add package NorthernNerds.Aspire.Neo4
```
## Usage
Here’s a quick example of how to use `NorthernNerds.Aspire.Neo4` in your project:
In `AppHost`, add the resource:
```csharp
using NorthernNerds.Aspire.Neo4;
var builder = DistributedApplication.CreateBuilder(args);
// username and password are secrets
var neo4jPass = builder.AddParameter("neo4j-pass", secret: true);
var neo4jUser = builder.AddParameter("neo4j-user", secret: true);
// add Neo4j resource
var neo4jDb = builder.AddNeo4j("graph-db", neo4jUser, neo4jPass);
```
For local development, add the parameters to `appsettings.json`:
```json
{
"Parameters": {
"neo4j-pass": "Password",
"neo4j-user": "neo4j"
}
}
```
Then in the "client" code, add the Neo4j client:
```csharp
using NorthernNerds.Aspire.Neo4;
builder.AddNeo4jClient("graph-db");
```
This will register an `IDriver` as a singleton in the service collection, which can be injected into your services.
```csharp
using Neo4j.Driver;
public class MyService
{
private readonly IDriver _driver;
public MyService(IDriver driver)
{
_driver = driver;
}
public async Task DoSomething()
{
var session = _driver.AsyncSession();
await session.RunAsync("MATCH (n) RETURN n");
}
}
```
## Documentation
- [Release Guide](docs/RELEASE_GUIDE.md): Instructions on how to release a new version of the package.
## Contributing
Contributions are welcome! Please see the [CONTRIBUTING.md](docs/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.