Skip to content

index.md

Latest commit

 

History

History
81 lines (62 loc) · 5.27 KB

index.md

File metadata and controls

81 lines (62 loc) · 5.27 KB
Raw
title ES.FX
description A collection of reusable .NET 10 libraries published as ES.FX.* NuGet packages, from core primitives to the Ignite application bootstrap.

ES.FX (EmberStack Framework) is a collection of reusable .NET libraries and application frameworks, published as ES.FX.* NuGet packages. Its flagship is Ignite — an opinionated, "just add water" bootstrap that wires OpenTelemetry, health checks, HttpClient resilience, and service integrations from a single call.

What is ES.FX

ES.FX is a set of independently consumable .NET 10 libraries. Each package targets net10.0 and lives under the ES.FX.* namespace. Take only the layer you need: pick a single core primitive, add a focused helper for a third-party library, or adopt the full Ignite bootstrap for a new service — the layers stack, but none forces the ones above it on you.

Everything is delivered as NuGet packages from NuGet.org and GitHub Packages. If you are consuming ES.FX in an app, start with Getting started. If you are contributing to the framework itself, start with the Development guide.

The layers

ES.FX is organized in five layers. Dependencies point downward — an upper layer may build on a lower one, never the reverse — so you can adopt any layer in isolation.

Layer What it is Start here
Core (ES.FX) Framework-agnostic primitives: Result/Problem error handling, Optional<T>, DurationValue, ValueRange, and BCL-style extensions. Results & Problems, Primitives
Additions (ES.FX.Additions.*) Focused, low-opinion helpers — each package augments exactly one third-party dependency and nothing else. Additions catalog
Hosting (ES.FX.Hosting) ProgramEntry / ProgramEntryBuilder — a lifecycle wrapper around Main with structured startup, error handling, and graceful shutdown. Application hosting
Ignite (ES.FX.Ignite + Sparks) The opinionated bootstrap and its pluggable Sparks — self-contained service integrations that bind config, register DI, add health checks, and wire OpenTelemetry. Ignite overview
Feature libraries Standalone libraries independent of Ignite: Transactional Outbox, Migrations, the Zendesk API client, and the Hermes Agent API client. Framework libraries

Meet Ignite

Ignite activates in two phases around the build boundary: builder.Ignite(...) runs on the IHostApplicationBuilder before the host is built, and app.Ignite() runs on the built IHost. Between them you register Sparks — one line each — to plug services into the host.

var builder = WebApplication.CreateBuilder(args);

builder.Ignite();            // Phase A: OpenTelemetry, health checks, resilience, config
builder.IgniteRedisClient(); // add a Spark — registers IConnectionMultiplexer, health check, tracing

var app = builder.Build();

app.Ignite();                // Phase B: middleware + health-check endpoints (web hosts)
await app.RunAsync();

Note

builder.Ignite(...) (on IHostApplicationBuilder) and app.Ignite() (on IHost) are two distinct calls. Web-only middleware wired in Phase B applies only to WebApplication hosts; worker and console hosts skip it and simply get no web middleware.

For the full walkthrough, see the Quickstart and the Ignite overview.

Choose your path

I want to… Go to
Install ES.FX and stand up my first Ignite app Getting started → Quickstart
Understand the vocabulary (Ignite, Sparks, Settings vs Options) Core concepts
Plug a service into Ignite Sparks catalog
Add a helper for a specific third-party library Additions catalog
Use the core error-handling and primitive types Results & Problems, Primitives
Use a standalone feature library Transactional Outbox, Migrations, Zendesk client, Hermes Agent client
Expose Zendesk to an AI agent (MCP server) Zendesk MCP server
Drive a Nous Research Hermes agent from .NET Hermes Agent client → Hermes Agent Spark
Build, test, or contribute to the framework Development guide

See also