ServantSoftware.SettingsOnEF.Json 1.0.0.36

ServantSoftware.SettingsOnEF.Json

An EF Core extension for centralizing application settings in the database. Each setting class corresponds to a table, with each table having a single-row configuration.

Table of Contents

• Features
• Getting Started
• Usage
• Contributing
• License

Features

• Easy Setup: Integrate with your existing EF Core projects seamlessly.
• Centralized Settings: Store and manage your app settings in a unified manner.
• Single-row Configurations: Each setting class corresponds to a table with a unique configuration row.

Getting Started

Prerequisites

• .NET 7 or higher
• An existing EF Core project

Installation

1. Install the ServantSoftware.SettingsOnEF.Json package via NuGet:

dotnet add package ServantSoftware.SettingsOnEF.Json

Package Name	Release (NuGet)
ServantSoftware.SettingsOnEF.Json

Usage

1. Define your settings class and mark it with the SettingsEntity attribute. Here is an example:

namespace SettingsOnEF.Tests.Test_Classes;

[SettingsEntity]
public class SomeSetting
{
    public string SomeProperty { get; set; }
}

2. Use the Get and Update methods from JsonSettingsManager to retrieve and update settings:

var settingsManager = new JsonSettingsManager("MyCompanyName", "MyProductName");

var setting = settingsManager.Get<SomeSetting>();
setting.SomeProperty = "NewValue";
settingsManager.Update(setting);

Your application settings will be stored under Environment.SpecialFolder.CommonApplicationData. For example on Windows, the default location in this sample will be:

C:\ProgramData\MyCompanyName\MyProductName\Settings

For more detailed documentation, check our Wiki.

Contributing

We welcome contributions to SettingsOnEF! Here's how you can help:

1. Fork the repository on GitHub.
2. Clone your fork locally.
3. Commit your changes on a dedicated branch.
4. Push your branch to your fork.
5. Submit a pull request from your fork to the main repository.
6. Engage in the review process and address feedback.

Please read our CONTRIBUTING.md for details on the process and coding standards.

Issues

Feel free to submit issues and enhancement requests.

License

SettingsOnEF is licensed under the MIT License. See LICENSE for more information.