Synergy.Admin 1.1.3

Synergy.Admin

A lightweight .NET library for Admin management (Modules, Menus, and Pages) using DDD, Event Sourcing with Marten DB, and Kafka messaging.

Features

• Module Management: Create, update, delete, and query modules
• Menu Management: Create, update, delete, and query menus with module associations
• Page Management: Create, update, delete, and query pages
• Event Sourcing: Full event sourcing with Marten DB
• Kafka Integration: Optional Kafka messaging for distributed systems
• Auto-Configuration: Zero changes required to your Program.cs

Installation

dotnet add package Synergy.Admin

Configuration

The package automatically configures itself using your project's appsettings.json. No changes to Program.cs are required!

Required Configuration

Add the following to your appsettings.json:

{
  "ConnectionStrings": {
    "DefaultConnection": "Host=localhost;Port=5432;Database=mydb;Username=postgres;Password=yourpassword"
  },
  "Kafka": {
    "BootstrapServers": "localhost:9092"
  }
}

Optional: Extended Configuration

For more control, you can use the SynergyAdmin section:

{
  "SynergyAdmin": {
    "ConnectionString": "Host=localhost;Port=5432;Database=mydb;Username=postgres;Password=yourpassword",
    "EnableKafka": true,
    "Kafka": {
      "BootstrapServers": "localhost:9092"
    },
    "EnableKeycloak": false,
    "Keycloak": {
      "BaseUrl": "https://your-keycloak-server/",
      "Realm": "your-realm",
      "ClientId": "your-client-id",
      "ClientSecret": "your-client-secret"
    }
  }
}

Configuration Options

How It Works

The package uses ASP.NET Core's IHostingStartup feature to automatically configure services when your application starts. This means:

1. ✅ Your appsettings.json configuration is used
2. ✅ No modifications to Program.cs required
3. ✅ Controllers are automatically registered
4. ✅ MediatR handlers are automatically discovered
5. ✅ Marten DB projections are configured
6. ✅ Kafka producers/consumers are set up (if enabled)

API Endpoints

Once installed, the following endpoints are available:

Modules

• POST /api/Module/Create - Create a new module
• PUT /api/Module/Update - Update an existing module
• DELETE /api/Module/Delete - Delete a module
• GET /api/Module/GetSingle - Get a single module by ID
• GET /api/Module/GetList - Get list of modules

Menus

• POST /api/Menu/Create - Create a new menu
• PUT /api/Menu/Update - Update an existing menu
• DELETE /api/Menu/Delete - Delete a menu
• GET /api/Menu/GetSingle - Get a single menu by ID
• GET /api/Menu/GetList - Get list of menus

Pages

• POST /api/Pages/Create - Create a new page
• PUT /api/Pages/Update - Update an existing page
• DELETE /api/Pages/Delete - Delete a page
• GET /api/Pages/GetSingle - Get a single page by ID
• GET /api/Pages/GetList - Get list of pages

Manual Configuration (Optional)

If you prefer to manually configure the services (instead of auto-configuration), you can disable the hosting startup and call the extension method directly:

1. Disable Auto-Configuration

Set the environment variable:

ASPNETCORE_PREVENTHOSTINGSTARTUP=true

Or in launchSettings.json:

{
  "profiles": {
    "YourProject": {
      "environmentVariables": {
        "ASPNETCORE_PREVENTHOSTINGSTARTUP": "true"
      }
    }
  }
}

2. Manual Setup in Program.cs

using Synergy.Admin.Infrastructure.Configuration;

var builder = WebApplication.CreateBuilder(args);

// Add Synergy Admin services manually
builder.Services.AddSynergyAdmin(builder.Configuration);

// ... rest of your configuration

Requirements

• .NET 8.0 or later
• PostgreSQL database
• Kafka (optional, for messaging)

Dependencies

• Marten (Event Sourcing & Document DB)
• MassTransit (Messaging)
• MediatR (CQRS)
• FluentValidation
• Serilog (Logging)

License

Copyright © 2025 Synergy Team