Repository files navigation

The Datasync Community Toolkit is a collection of libraries that implement a client-server system used for synchronizing datafrom the database table. The Datasync Community Toolkit is a member of the Community Toolkit organization and published under the dotnet Foundation.

Currently, the library supports:

• Server:ASP.NET 8 or later
• Client: .NET 8 or later

The client platforms that have been tested include:

• Avalonia UI
• .NET MAUI
• Uno Platform
• Windows Presentation Framework (WPF)
• Windows UI Library (WinUI) 3

We support most databases that are supported by Entity Framework Core, along with an in-memory store and LiteDb. Support for additionaldatabase types is easily added through our flexible repository pattern.

Other platforms may work, but have not been tested.

Please take a look at the tutorials included in ourdocumentation.

You can easily get started by using thedotnet new command to create a new datasync server. The template pre-configured ASP.NET Core,Entity Framework Core, and the Datasync server libraries. To install the template:

dotnet new -i CommunityToolkit.Datasync.Server.Template.CSharp

To create a project:

mkdir My.Datasync.Servercd My.Datasync.Serverdotnet new datasync-server

The following NuGet packages have been published:

Package	Version	Downloads
CommunityToolkit.Datasync.Client
CommunityToolkit.Datasync.Server
CommunityToolkit.Datasync.Server.Abstractions
CommunityToolkit.Datasync.Server.Automapper
CommunityToolkit.Datasync.Server.CosmosDB
CommunityToolkit.Datasync.Server.EntityFrameworkCore
CommunityToolkit.Datasync.Server.InMemory
CommunityToolkit.Datasync.Server.LiteDb
CommunityToolkit.Datasync.Server.MongoDB
CommunityToolkit.Datasync.Server.NSwag
CommunityToolkit.Datasync.Server.OpenApi
CommunityToolkit.Datasync.Server.Swashbuckle

The majority of tests in the test suite provideTestContainers so that the tests are run against real servers running inside containers. However, some test suites have not been set up yet or do not work as expected. For those services, you will need to provide a real service and configure the.runsettings file to run the service. Here is a typical.runsettings file:

<?xml version="1.0" encoding="utf-8"?><RunSettings>  <RunConfiguration>    <EnvironmentVariables>      <ENABLE_SQL_LOGGING>true</ENABLE_SQL_LOGGING>      <COSMOS_CONNECTION_STRING>{insert your connection string here}</COSMOS_CONNECTION_STRING>      <AZSQL_CONNECTION_STRING>{insert your connection string here}</AZSQL_CONNECTION_STRING>    </EnvironmentVariables>  </RunConfiguration></RunSettings>

NOTE: The.runsettings file contains secrets. It should not be checked in. We have added this file to the.gitignore to ensure that it isnot checked into public GitHub repositories.

Read what weplan for next iterations, and feel free to ask questions.

We welcome community contributions. Check out ourcontributing guide to get started.

This project has adopted the code of conduct defined by theContributor Covenant to clarify expected behavior in our community.For more information see the.NET Foundation Code of Conduct.

This project is supported by the.NET Foundation.

The Datasync Toolkit used to be known as Azure Mobile Apps. You can find the code for previous (unsupported) versions of the library at theold repository.