amolenk/dotnet-sdk

Dapr SDK for .NET

Dapr SDK for .NET

Dapr is a portable, event-driven, serverless runtime for building distributed applications across cloud and edge.

• dapr.io
• @DaprDev

Dapr SDK for .NET allows you to implement the Virtual Actor model, based on the actor design pattern. This SDK can run locally, in a container and in any distributed systems environment.

This repo builds the following packages:

• Dapr.Client
• Dapr.AspNetCore
• Dapr.Actors
• Dapr.Actors.AspNetCore
• Dapr.Extensions.Configuration

Getting Started

Prerequesites

Each project is a normal C# Visual Studio 2019 project. At minimum, you need .NET Core SDK 3.1 to build and generate NuGet packages.

We recommend installing Visual Studio 2019 v16.4 or later which will set you up with all the .NET build tools and allow you to open the solution files. Community Edition is free and can be used to build everything here. Make sure you update Visual Studio to the most recent release. To find a version of .NET Core that can be used with earlier versions of Visual Studio, see .NET SDKs for Visual Studio.

Solution Files

The repo currently has 4 solution files:

• all.sln: This includes all the sdk product, test and samples project files.
• src/prod.sln: This includes all the product project files.
• samples/samples.sln: This includes all the sample projects files dependencies project files.
• test/test.sln: This includes all the test projects and dependencies project files.

Build

To build everything and generate NuGet packages, run dotnet cli commands. Binaries and NuGet packages will be dropped in a bin directory at the repo root.

# Build sdk, samples and tests.
dotnet build -c Debug  # for release, -c Release

# Run unit-test
dotnet test test/test.sln

# Generate nuget packages in /bin/Debug/nugets
dotnet pack src/prod.sln

Each project can also be built individually directly through Visual Studio. You can open the solution file all.sln in repo root to load all sdk, samples and test projects.

Releases

We publish nuget packages to nuget.org for each release.

Using nugets built locally in your project

<RepoRoot> is the path where you cloned this repository. Nuget packages are dropped under /bin/<Debug|Release>/nugets when you build locally.

Examples:

# Add Dapr.Actors nuget package
dotnet add package Dapr.Actors -s <RepoRoot>/bin/<Debug|Release>/nugets

# Add Dapr.Actors.AspNetCore nuget package
dotnet add package Dapr.Actors.AspNetCore -s <RepoRoot>/bin/<Debug|Release>/nugets

Documentation

These articles will help get you started with Dapr runtime and Dapr Actors:

• Getting started with Dapr Actor
• Dapr CLI
• Dapr Actors API Reference