ServantSoftware.SettingsOnADO.Json 1.0.1

ServantSoftware.SettingsOnADO.Json

An ADO.NET extension for centralizing application settings in a folder of JSON files. Each setting class corresponds to a JSON file, with its contents only having one instance of the setting class serialized.

👁 Build Status
👁 Version
👁 License

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 Framework 4.6.1/.NET 7 or higher

Installation

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

dotnet add package ServantSoftware.SettingsOnADO.Json

Usage

1. Define your settings class with properties of simple data types. Here is an example:

namespace SettingsOnADO.Tests.TestClasses;

public class TestSettings
{
 public int Id { get; set; }
 public string Name { 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<TestSettings>();
setting.Name = "MyName";
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 SettingsOnADO! 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 for details on the process and coding standards.

Issues

Feel free to submit issues and enhancement requests.

License

SettingsOnADO is licensed under the MIT License. See for more information.