Long-form documentation for netfly, the .NET member of the Firefly Framework. Each file targets a specific audience or task; this index is the recommended starting point.
The product name is netfly. Package names, namespaces and APIs retain their
existing FireflyFramework.* identifiers; installation commands and repository
URLs remain unchanged.
| Document | Audience | What it covers |
|---|---|---|
INSTALL.md |
Anyone consuming the packages | Installing from NuGet.org (stable) vs. GitHub Packages (pre-release) vs. local project references; one-time nuget.config template; PAT creation; CI authentication. |
ARCHITECTURE.md |
Anyone integrating with the framework | The four-tier layering (Foundational → Platform → Adapters → Starters), inter-project dependency direction, the process model the runtime assumes, and the framework's versioning policy. |
MODULES.md |
Anyone picking which package(s) to install | One-line description of every src/* project paired with its Java original, organised by tier. The "what's in this package" reference. |
SERVICE-SCAFFOLDING.md |
Service authors building on the framework | The canonical five-project layout (.Interfaces / .Models / .Core / .Web / .Sdk), naming conventions, dependency graph, and a step-by-step bootstrap recipe modelled on the Orders sample. |
CONFIGURATION.md |
Service authors + operators | Every Firefly:* configuration section with the real *Options type signatures, default values, and worked examples. |
MIGRATION-GUIDE.md |
Teams porting an existing Java service | Mapping table from Reactor / Spring DI / Spring Web / Spring Data R2DBC / Spring Cloud / Resilience4j / Micrometer / Logback to their .NET 10 counterparts, with side-by-side code samples. |
If you're new to the framework, read in this order:
INSTALL.md— get the packages resolving in your project. Two minutes.ARCHITECTURE.md— orient on the layering model and the dependency direction. Five minutes.SERVICE-SCAFFOLDING.md— see what a real service looks like end-to-end before reading individual module docs. Ten minutes.MODULES.md— skim the catalogue; bookmark the modules you'll use.CONFIGURATION.md— keep open while wiring up yourappsettings.json.
If you're porting an existing Java service, start with MIGRATION-GUIDE.md instead.
Each project under src/ ships its own README.md
describing its public surface, options class, and short usage examples.
The same is true of every project under samples/.
src/README.md indexes them by tier.
The repository root README.md covers the
five-minute pitch, the architecture diagram, the canonical
service-shape, two quickstart paths (run the sample / build your
first service from scratch), and the release-publish workflow.