Skip to content

getting-started.md

Latest commit

 

History

History
60 lines (38 loc) · 2.34 KB

getting-started.md

File metadata and controls

60 lines (38 loc) · 2.34 KB
Raw

Getting started: your first SquidStd host

Build a minimal SquidStd application: a bootstrapper that loads config, configures logging, and runs the registered services until shutdown.

What you'll build

A console host on top of SquidStdBootstrap (from SquidStd.Services.Core, which brings in SquidStd.Core and SquidStd.Abstractions). It loads its config, wires the default services, and runs until you stop it.

Prerequisites

  • .NET 10 SDK
  • dotnet add package SquidStd.Services.Core

Steps

1. Create the bootstrapper

SquidStdBootstrap.Create takes a SquidStdOptions (config name + root directory) and registers the configuration core (directories, the logger section and the config manager) into an owned DryIoc container. The core services (event bus, jobs, timers…) are explicit: opt in with bootstrap.ConfigureServices(c => c.RegisterCoreServices()).

[!code-csharp]

2. Start the services

StartAsync starts every registered ISquidStdService in priority order.

[!code-csharp]

3. Run until shutdown

RunAsync starts (if not already started), waits for cancellation, then stops the services cleanly. Use either StartAsync plus your own loop, or just RunAsync.

[!code-csharp]

Run it

dotnet run --project samples/SquidStd.Samples.GettingStarted

The host starts, logs the service lifecycle, and waits until you press Ctrl+C.

How it works

SquidStdBootstrap is the composition root: it builds the container, registers the configuration core, loads the config sections, and orchestrates the ISquidStdService lifecycle. Need to inspect or tweak a loaded value before services start? See Inspecting and overriding loaded configuration. The core services come from the explicit RegisterCoreServices() call in ConfigureServices, and every other SquidStd module plugs into the same container through its Add… extension methods.

See also