Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![NuGet Version](https://img.shields.io/nuget/v/Trax.Dashboard)](https://www.nuget.org/packages/Trax.Dashboard/)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)

Operations control room for [Trax](https://www.nuget.org/packages/Trax.Effect/) — a Blazor Server dashboard for monitoring train journeys, timetables, dead letters, and live station service configuration.
Operations control room for [Trax](https://www.nuget.org/packages/Trax.Effect/). A Blazor Server dashboard for monitoring train journeys, timetables, dead letters, and live station service configuration.

## What This Does

Expand Down Expand Up @@ -46,27 +46,27 @@ app.UseTraxDashboard("/my-dashboard");

### Home

Overview of the whole network — summary cards showing train counts by state, a donut chart of journey outcomes, and a 24-hour departure timeline.
Overview of the whole network. Summary cards showing train counts by state, a donut chart of journey outcomes, and a 24-hour departure timeline.

### Trains

The departure board. Grid of all registered `IServiceTrain<,>` implementations discovered in your assemblies interface type, concrete type, cargo in, cargo out, and DI lifetime. Useful for verifying that your trains are wired up correctly.
The departure board. Grid of all registered `IServiceTrain<,>` implementations discovered in your assemblies: interface type, concrete type, cargo in, cargo out, and DI lifetime. Useful for verifying that your trains are wired up correctly.

### Data

- **Metadata** the journey log. Execution history for every train run. Filter by state, train name, or time range. Cancel trains in transit directly from the grid.
- **Logs** application logs captured during train journeys.
- **Manifests** the timetable. Scheduled train definitions from Trax.Scheduler. View schedule, retry policy, last departure time, and enable/disable individual manifests.
- **Manifest Groups** fleet-level statistics and dispatch settings (max active trains, priority) per group.
- **Dead Letters** the lost shipment office. Trains that derailed beyond their retry limit. Inspect the failure details and decide whether to re-dispatch or discard.
- **Metadata**: the journey log. Execution history for every train run. Filter by state, train name, or time range. Cancel trains in transit directly from the grid.
- **Logs**: application logs captured during train journeys.
- **Manifests**: the timetable. Scheduled train definitions from Trax.Scheduler. View schedule, retry policy, last departure time, and enable/disable individual manifests.
- **Manifest Groups**: fleet-level statistics and dispatch settings (max active trains, priority) per group.
- **Dead Letters**: the lost shipment office. Trains that derailed beyond their retry limit. Inspect the failure details and decide whether to re-dispatch or discard.

### Effects

Toggle individual station services on or off at runtime. Adjust settings like log levels and serialization options without restarting the application.

### User Settings

Per-session preferences polling interval for live data, visibility toggles for dashboard sections.
Per-session preferences: polling interval for live data, visibility toggles for dashboard sections.

## Requirements

Expand All @@ -75,11 +75,11 @@ Trax.Dashboard is a Razor Class Library built on Blazor Server with [Radzen](htt
- ASP.NET Core (the Web SDK)
- Interactive Server render mode enabled (Blazor Server)

The dashboard handles its own static assets and routing you don't need to configure Radzen separately.
The dashboard handles its own static assets and routing, so you don't need to configure Radzen separately.

## Part of Trax

Trax is a layered framework — each package builds on the one below it. Stop at whatever layer solves your problem.
Trax is a layered framework. Each package builds on the one below it, so stop at whatever layer solves your problem.

```
Trax.Core pipelines, junctions, railway error propagation
Expand Down
Loading