Skip to content

Local Development

This page is derived from the repository root README and collects the main local development workflows in one place.

Documentation Pointers

GitHub Package Authentication

HyperPath consumes private NuGet packages from https://nuget.pkg.github.com/HyperPath-Solutions/index.json.

Create a classic GitHub personal access token with:

  • read:packages
  • repo

Add the feed once:

dotnet nuget add source https://nuget.pkg.github.com/HyperPath-Solutions/index.json \
  --name github-hyperpath \
  --username YOUR_GITHUB_USERNAME \
  --password YOUR_GITHUB_PAT \
  --store-password-in-clear-text

Verify sources and restore:

dotnet nuget list source
dotnet restore ./HyperPath.slnx

Start the Distributed App

Use .NET Aspire to run the application locally.

curl -sSL https://aspire.dev/install.sh | bash
aspire run

VS Code also provides a launch configuration for the AppHost.

NServiceBus License

Install a developer license from Particular and place it in the ParticularSoftware folder in your local profile.

Login

Open the Gateway service from Aspire and sign in with a seeded user such as admin1@example.com / password.

Slide Worker Configuration

For local worker configuration, copy src/HyperPath.SlideWorker/appsettings.Development.Sample.json to appsettings.Development.json and adjust it for your machine.

For the end-to-end tenant upload and viewer flow, see /imaging/slide-ingestion-flow/.

WSI Sample Images

The gitignored wsi_samples/ directory holds whole-slide images for local testing.

dotnet run scripts/FetchWsiTestData.cs
dotnet run scripts/FetchWsiTestData.cs --force
dotnet run scripts/FetchWsiTestData.cs --output /path/to/samples

The sample set mirrors the OpenSlide test-data catalog by vendor.

Run SlideWorker Against Local Files

Use one-shot local conversion when you want to validate slide processing without the full distributed stack.

dotnet run --project src/HyperPath.SlideWorker -- --localPath wsi_samples/Aperio/CMU-1.svs
dotnet run --project src/HyperPath.SlideWorker -- --localPath wsi_samples/Aperio
dotnet run --project src/HyperPath.SlideWorker -- --localPath wsi_samples

Debugging

HyperPath.EmployeeWeb

  • Run Aspire in debug mode.
  • In VS Code, choose C#: HyperPath.AppHost [Default Configuration].
  • Open EmployeeWeb in a browser.

HyperPath.Web WASM

  • Start the stack with aspire run.
  • In VS Code, choose Debug: Tenant 1 (Blazor WASM).
  • Sign in through the Gateway if the debugging browser does not already have a login cookie.