BAUERGROUP.Shared.Desktop 3.0.3

BAUER GROUP Shared Platform

A comprehensive multi-target .NET shared library platform providing essential building blocks for enterprise applications within the BAUER GROUP ecosystem. Supports .NET 10, .NET 8, and .NET Standard 2.0 for maximum compatibility.

Overview

The BAUER GROUP Shared Platform is a modular, multi-project solution designed to accelerate development across the organization. It provides battle-tested implementations for common enterprise requirements including logging, data persistence, API integrations, cloud services, and desktop UI components.

Key Features

• Multi-Target Support: .NET 10, .NET 8, and .NET Standard 2.0 for broad compatibility
• Modular Architecture: Pick only the packages you need
• Enterprise-Ready Logging: NLog-based logging with Sentry integration for error tracking
• Data Layer: Support for SQLite (persistent key-value storage), LiteDB, and in-memory databases
• API Integrations: Generic REST API client with RestSharp
• Cloud Services: Cloudinary media management, RemoveBG background removal, Fixer.io currency exchange
• Desktop Components: WPF/WinForms utilities with embedded Chromium browser support
• Reporting: Stimulsoft Reports integration for professional reporting

Packages

*Requires separate Stimulsoft license

Installation

Via NuGet Package Manager

# Core package (required)
Install-Package BAUERGROUP.Shared.Core

# Optional packages
Install-Package BAUERGROUP.Shared.Data
Install-Package BAUERGROUP.Shared.API
Install-Package BAUERGROUP.Shared.Cloud
Install-Package BAUERGROUP.Shared.Desktop
Install-Package BAUERGROUP.Shared.Desktop.Browser
Install-Package BAUERGROUP.Shared.Desktop.Reporting

Via .NET CLI

dotnet add package BAUERGROUP.Shared.Core

Quick Start

Logging with BGLogger

using BAUERGROUP.Shared.Core.Logging;

// Configure logging (settings are applied through the Configuration property)
BGLogger.Configuration.ApplicationName = "MyApplication";
BGLogger.Configuration.LogDirectory = @"C:\Logs";

// Enable Sentry error tracking (optional)
BGLogger.Configuration.SentryDsn = "https://your-sentry-dsn@sentry.io/project";
BGLogger.Configuration.SentryEnvironment = "production";
BGLogger.Configuration.ErrorTracking = true;

// Enable additional targets as needed
BGLogger.Configuration.Console = true;
BGLogger.Configuration.File = true; // Enabled by default

// Use the logger
BGLogger.Info("Application started");
BGLogger.Error(exception, "An error occurred");

// Enable automatic unhandled exception reporting
BGLogger.UnhandledExceptionReporting(true);

Data Persistence with SQLite

using BAUERGROUP.Shared.Data.EmbeddedDatabase;

// Create a thread-safe, persistent key-value dictionary backed by SQLite
using var storage = new ConcurrentPersistentDictionary<string, MyData>(
    dataStorageDirectory: @"C:\Data",
    databaseName: "MyDatabase",
    tableName: "MyTable"
);

// Store and retrieve data
storage.Create("key1", new MyData { Name = "Example" });
var data = storage.Read("key1");
bool exists = storage.Exists("key1");
storage.Delete("key1");

// Read all entries
var allData = storage.Read();
var allWithKeys = storage.ReadWithKeys();

Embedded Browser (WPF)

using BAUERGROUP.Shared.Desktop.Browser;

// Show embedded Chrome browser window (non-blocking)
WPFToolboxBrowser.ChromeEmbeddedWebbrowserWindow(
    title: "Web View",
    url: "https://example.com",
    owner: this,
    wait: false
);

// Show browser and wait for it to close (modal dialog)
WPFToolboxBrowser.ChromeEmbeddedWebbrowserWindow(
    title: "Web View",
    url: "https://example.com",
    owner: this,
    wait: true
);

// Take a screenshot of a website
await WPFToolboxBrowser.MakeWebsiteScreenshot(
    "https://example.com",
    "screenshot.png"
);

Requirements

Runtime Requirements

• .NET 10.0, .NET 8.0, or .NET Standard 2.0 compatible runtime
• Windows (for Desktop packages: Desktop, Desktop.Browser, Desktop.Reporting)

Optional Requirements

• Stimulsoft License - Required for BAUERGROUP.Shared.Desktop.Reporting
• Sentry Account - For error tracking integration

Project Structure

BAUERGROUP.Shared.Plattform/
├── src/
│   ├── BAUERGROUP.Shared.Core/                 # Core utilities & logging
│   ├── BAUERGROUP.Shared.Data/                 # Data persistence layer
│   ├── BAUERGROUP.Shared.API/                  # Generic REST API client
│   ├── BAUERGROUP.Shared.Cloud/                # Cloud service integrations
│   ├── BAUERGROUP.Shared.Desktop/              # WPF/WinForms utilities
│   ├── BAUERGROUP.Shared.Desktop.Browser/      # Embedded browser
│   └── BAUERGROUP.Shared.Desktop.Reporting/    # Reporting components
├── tests/
│   └── BAUERGROUP.Shared.Plattform.Test/       # Unit tests
├── assets/                                     # Application icons
├── docs/
│   ├── BUILD.md                                # Build documentation
│   ├── DEPENDENCY-LICENSES.md                  # License analysis
│   ├── DOCUMENTATION-PLATFORM-SPEC.md          # Platform specification
│   ├── INSTALLATION.md                         # Installation guide
│   └── VERSIONING.md                           # Version management
├── CHANGELOG.md                                # Version history
├── Directory.Build.props                       # Shared build configuration
├── Directory.Packages.props                    # Central package management
└── BAUERGROUP.Shared.Plattform.sln             # Solution file

Building from Source

Prerequisites

• .NET 10 SDK (includes support for .NET 8 and earlier)
• Visual Studio 2022 (17.12+) or JetBrains Rider 2024.3+

Build

# Clone the repository
git clone https://github.com/bauergroup/BAUERGROUP.Shared.Plattform.git
cd BAUERGROUP.Shared.Plattform

# Restore dependencies
dotnet restore

# Build solution
dotnet build

# Run tests
dotnet test

Creating NuGet Packages

dotnet pack --configuration Release

Packages will be output to bin/Release/*.nupkg

Configuration

NLog Configuration

The library uses NLog for logging. Configuration is done programmatically via BGLogger.Configuration:

// Available logging targets (can be enabled/disabled at runtime)
BGLogger.Configuration.File = true;           // File logging (default: enabled)
BGLogger.Configuration.Console = true;        // Console output
BGLogger.Configuration.ConsoleColored = true; // Colored console output
BGLogger.Configuration.Network = true;        // UDP network logging
BGLogger.Configuration.NLogViewer = true;     // NLog Viewer (Log4J XML format)
BGLogger.Configuration.Memory = true;         // In-memory log storage
BGLogger.Configuration.Debugger = true;       // VS Debugger output
BGLogger.Configuration.Eventlog = true;       // Windows Event Log (.NET only)
BGLogger.Configuration.ErrorTracking = true;  // Sentry integration

Sentry Integration

Sentry error tracking is integrated via the official Sentry.NLog package:

// Configure Sentry (must set DSN before enabling ErrorTracking)
BGLogger.Configuration.SentryDsn = "https://...@sentry.io/...";
BGLogger.Configuration.SentryEnvironment = "production";
BGLogger.Configuration.SentryMinimumEventLevel = NLog.LogLevel.Error;
BGLogger.Configuration.SentryMinimumBreadcrumbLevel = NLog.LogLevel.Debug;
BGLogger.Configuration.ErrorTracking = true;

Features:

• Automatic integration with NLog pipeline
• Breadcrumbs, context, and event capture
• User tracking with Windows identity
• Tags for ApplicationName, MachineName, ProcessName

Third-Party Licenses

This project uses various open-source packages. See DEPENDENCY-LICENSES.md for a complete license analysis.

Key Dependencies

Contributing

Contributions are welcome! Please follow these guidelines:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Code Style

• Follow Microsoft's C# Coding Conventions
• Use meaningful names for variables, methods, and classes
• Write XML documentation for public APIs
• Include unit tests for new functionality

Support

For questions or issues:

• Internal: Contact BAUER GROUP Development Team
• GitHub Issues: Report an issue

License

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

Note: Some dependencies (Stimulsoft) require separate commercial licenses. See DEPENDENCY-LICENSES.md for details.

BAUER GROUP - Building Better Software Together