# `PgFlowDashboard`
[🔗](https://github.com/agoodway/pgflow/blob/v0.1.0/lib/pgflow_dashboard.ex#L1)

A Phoenix LiveView dashboard for monitoring PgFlow workflow execution.

PgFlowDashboard provides real-time visibility into workflow execution with
a read-only, security-first approach.

## Features

- Real-time overview of workers, runs, and queue depth
- Detailed run inspection with step states and task details
- Flow visualization with dependency graphs
- Worker health monitoring
- GitHub-style run history grid

## Installation

1. Add the dashboard to your router:

    defmodule MyAppWeb.Router do
      use MyAppWeb, :router

      import PgFlowDashboard.Router

      scope "/" do
        pipe_through [:browser]
        pgflow_dashboard "/pgflow",
          repo: MyApp.Repo,
          pubsub: MyApp.PubSub,
          auth_handler: MyAppWeb.PgFlowAuth
      end
    end

2. Generate and run the dashboard migration:

    mix pgflow_dashboard.gen.migration
    mix ecto.migrate

## Configuration Options

See `PgFlowDashboard.Config` for all available options.

# `child_spec`

Returns the child specification for starting PgFlowDashboard's supervision tree.

This allows adding PgFlowDashboard to your application's supervision tree:

    children = [
      # ... other children
      PgFlowDashboard
    ]

Or with options:

    {PgFlowDashboard, name: MyApp.PgFlowDashboardSupervisor}

# `version`

```elixir
@spec version() :: String.t()
```

Returns the current version of PgFlowDashboard.

---

*Consult [api-reference.md](api-reference.md) for complete listing*