AppXDev.SyncEntityFramework.Domain 0.5.0

AppXDev.SyncEntityFramework

A bidirectional Entity Framework sync framework for distributed retail systems. Synchronize data between a central server and multiple store locations using SQL Server and message-based communication.

Features

• 🔄 Bidirectional Sync - Push and pull changes between central and store databases
• ⚡ Conflict Resolution - Configurable strategies (LastWriteWins, Merge, Manual)
• 📦 Entity Framework Core - Built on EF Core 9.0 with change tracking
• 🐰 RabbitMQ Integration - Message-based real-time sync notifications
• 🏪 Multi-Store Support - Scale to 100+ store locations
• 📝 Offline Support - Queue changes locally when disconnected (roadmap)

Installation

# Full SDK (includes Domain, Application, and Infrastructure)
dotnet add package AppXDev.SyncEntityFramework

# Or install individual packages
dotnet add package AppXDev.SyncEntityFramework.Domain
dotnet add package AppXDev.SyncEntityFramework.Application

Demos

This repository includes two demo applications to showcase the SDK capabilities:

1. Simple Console Demo

A basic example demonstrating how to set up the SDK, define a Sync Entity, and record changes.

dotnet run --project src/AppXDev.Sync.Demo.Console/AppXDev.Sync.Demo.Console.csproj

2. Multi-Store Simulation

A complex simulation of a 3-node topology (Central, Store A, Store B) demonstrating data propagation and conflict resolution.

dotnet run --project src/AppXDev.Sync.Demo.Simulation/AppXDev.Sync.Demo.Simulation.csproj

Quick Start

1. Define Syncable Entities

using AppXDev.Sync.Domain.Entities;

public class Product : SyncEntity
{
    public string Name { get; set; } = string.Empty;
    public decimal Price { get; set; }
    public int CategoryId { get; set; }
}

2. Configure Service Registration (DI)

In your Program.cs, register the necessary services:

using AppXDev.Sync.Domain.Interfaces;
using AppXDev.Sync.Application.Services;
using AppXDev.Sync.Infrastructure.Persistence;
using AppXDev.Sync.Infrastructure.Messaging;

// 1. Database
builder.Services.AddDbContext<SyncDbContext>(options =>
    options.UseSqlServer("YourConnectionString"));

// 2. Messaging (RabbitMQ)
builder.Services.AddSingleton<IMessageBroker, RabbitMqBroker>();

// 3. Sync Core Services
builder.Services.AddScoped<IChangeTracker, EfCoreChangeTracker>();
builder.Services.AddScoped<IConflictResolver, ConflictResolverService>();
builder.Services.AddScoped<ISyncEngine, SyncService>();

// 4. Manual Conflict Repository (Offline Mode)
builder.Services.AddScoped<ISyncConflictRepository, EfCoreSyncConflictRepository>();

3. Create a Store DbContext

3. Use Sync Service

using AppXDev.Sync.Application.Services;

// Pull changes from central
var pullResult = await syncService.PullAsync(new SyncContext(
    StoreId: "STORE-001",
    LastSyncTimestamp: lastSync
));

// Push local changes to central
var pushResult = await syncService.PushAsync(new SyncContext(
    StoreId: "STORE-001",
    LastSyncTimestamp: null
));

Packages

Requirements

• .NET 9.0 or later
• SQL Server (or compatible EF Core provider)
• RabbitMQ (optional, for real-time sync)

Documentation

• System Architecture
• System Architecture
• Project Roadmap
• Publishing Guide
• Code Standards

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please read our contributing guidelines before submitting pull requests.