Azure Mobile Apps

** This project is now archived and superceded by CommunityToolkit/Datasync

Azure Mobile Apps has been retired. While you are free to continue using this product as-is, no further updates will be made to it.

Future datasync library capabilities will be produced by the CommunityToolkit/Datasync project, including support for future versions of dotNET. Community Toolkit is a member of the dotNet Foundation.

---

Original README.md

Azure Mobile Apps (also known as the Microsoft Datasync Framework) is a set of client and server libraries for adding authenticated data access and offline synchronization to your mobile applications.

Currently, we support:

• Server: ASP.NET Core for .NET 6.
• Client: .NET Standard 2.0 and .NET 6.

The client platforms that support .NET Standard 2.0 and .NET 6 include:

• AvaloniaUI
• .NET MAUI
• Uno Platform
• Windows (UWP, WinUI3, WPF)
• Xamarin Forms
• Xamarin Native (Android and iOS)

Blazor and Unity are known to have issues with offline support since neither supports Sqlite natively.

To get started, take a look at our documentation.

The older (v4.2.0 and earlier) libraries are retired and no longer supported. You can find the source code in the archive branch.

Libraries

.NET (sdk/dotnet)

The server-side library uses ASP.NET Core 6.0 and provides stores for in-memory data, LiteDb, and Entity Framework Core.

Released and supported versions of the library will be distributed by the normal NuGet mechanism:

Package	Version	Downloads
Microsoft.AspNetCore.Datasync
Microsoft.AspNetCore.Datasync.Abstractions
Microsoft.AspNetCore.Datasync.EFCore
Microsoft.AspNetCore.Datasync.InMemory
Microsoft.AspNetCore.Datasync.LiteDb
Microsoft.AspNetCore.Datasync.NSwag
Microsoft.AspNetCore.Datasync.Swashbuckle
Microsoft.Datasync.Client
Microsoft.Datasync.Client.SQLiteStore

Templates

We provide a template for use with dotnet new. The template pre-configures ASP.NET Core, Entity Framework Core, and the Datasync Server libraries. To install the template:

dotnet new -i Microsoft.AspNetCore.Datasync.Template.CSharp

To create a server, use dotnet new:

mkdir My.Datasync.Server
cd My.Datasync.Server
dotnet new datasync-server

Documentation

You can find the latest documentation on docs.microsoft.com. Additional information will be added to the repository Wiki when appropriate.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.