Cloudey.Reflex.Core 3.0.0

Reflex

Core

An opinionated framework setup for common functionality.

Installation

Install with NuGet

For a quick start, use the AddReflexCore extension method on the host builder. This will register the logging, configuration, caching, validation, Autofac, and common ASP.NET Core services.

// Program.cs

var builder = WebApplication.CreateBuilder(args);

builder.AddReflexCore();

Git

Add the following to your .gitignore file to ignore local configuration files:

**/appsettings.Local.*
**/appsettings.*.Local.*

Including assemblies

Reflex makes extensive use of assembly scanning to discover types. You should mark your assemblies with the IncludeAssembly attribute to ensure they are included in the scanning process.

// Anywhere in the assembly
[assembly: IncludeAssembly]

Configuration

Usage

// Program.cs

var builder = WebApplication.CreateBuilder(args);
// ...
builder.AddReflexConfiguration(); // <-- Register configuration

Configuration files

Important: YAML files on the same level always take precedence over JSON files. It is highly recommended to use YAML files exclusively.

I.e. if you have both appsettings.json and appsettings.yaml in the same directory, the YAML file will be used.
If you have appsettings.yaml and appsettings.Development.json, the JSON file will be used in development.

Precedence - from highest to lowest:

• APP__ environment variables
• appsettings.{Environment}.Local.yaml
• appsettings.{Environment}.Local.json
• appsettings.{Environment}.yaml
• appsettings.{Environment}.json
• appsettings.Local.yaml
• appsettings.Local.json
• appsettings.yaml
• appsettings.json

Sentry

To enable Sentry, configure the DSN in your application settings (preferably in a .Local.yaml file):

Sentry:
 Dsn: YourSentryDsnFromSentryDashboard

Then enable logging:

// Program.cs

var builder = WebApplication.CreateBuilder(args);

// ...

builder.AddReflexLogging();

Logging

This package includes integration with Serilog and Sentry for logging.

Enable logging with:

// Program.cs

var builder = WebApplication.CreateBuilder(args);

// ...

builder.AddReflexLogging();

You can configure the logging level with the configuration key Logging.Level.

Made by

Cloudey

License

Licensed under Apache 2.0.
Copyright © 2023 Cloudey IT Ltd
Cloudey® is a registered trademark of Cloudey IT Ltd. Use of the trademark is NOT GRANTED under the license of this repository or software package.