🧰 Datasync Toolkit

The Datasync Community Toolkit is a collection of libraries that implement a client-server system used for synchronizing data from 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:

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

Other platforms may work, but have not been tested.

🙌 Getting Started

Please take a look at the tutorials included in our documentation.

You can easily get started by using the dotnet 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.Server
cd My.Datasync.Server
dotnet new datasync-server

📦 NuGet Packages

The following NuGet packages have been published:

Running Live Tests

The majority of tests in the test suite provide TestContainers 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 is not checked into public GitHub repositories.

🌍 Roadmap

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

🚀 Contribution

We welcome community contributions. Check out our contributing guide to get started.

📄 Code of Conduct

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

🏢 .NET Foundation

This project is supported by the .NET Foundation.

History

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

Datasync

Install / Use

README