https://github.com/evilmarty/oban_live_dashboard

A simple Phoenix Live Dashboard for Oban jobs.
https://github.com/evilmarty/oban_live_dashboard

elixir elixir-library elixir-phoenix hex oban phoenix phoenix-liveview

Last synced: 8 months ago
JSON representation

A simple Phoenix Live Dashboard for Oban jobs.

• Host: GitHub
• URL: https://github.com/evilmarty/oban_live_dashboard
• Owner: evilmarty
• License: apache-2.0
• Created: 2023-08-07T08:46:18.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2025-05-03T01:08:15.000Z (about 1 year ago)
• Last Synced: 2025-05-08T17:04:00.672Z (about 1 year ago)
• Topics: elixir, elixir-library, elixir-phoenix, hex, oban, phoenix, phoenix-liveview
• Language: Elixir
• Homepage:
• Size: 190 KB
• Stars: 53
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# Oban Live Dashboard

[![CI](https://github.com/evilmarty/oban_live_dashboard/actions/workflows/ci.yml/badge.svg)](https://github.com/evilmarty/oban_live_dashboard/actions/workflows/ci.yml)

[![Hex Version](https://img.shields.io/hexpm/v/oban_live_dashboard.svg)](https://hex.pm/packages/oban_live_dashboard)

[![Hex Docs](http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat)](https://hexdocs.pm/oban_live_dashboard)

[![Apache 2.0](https://img.shields.io/hexpm/l/oban_live_dashboard)](https://opensource.org/licenses/Apache-2.0)

A simple [Phoenix Live Dashboard](https://github.com/phoenixframework/phoenix_live_dashboard) for [Oban](https://github.com/sorentwo/oban) jobs.

## Installation

Follow these steps to get going.

### 1. Add the `oban_live_dashboard` dependency

If [available in Hex](https://hex.pm/docs/publish), the package can be installed

by adding `oban_live_dashboard` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:oban_live_dashboard, "~> 0.1.0"}

  ]

end

```

### 2. Update LiveView router

Next you'll need to update the `live_dashboard` configuration in your router.

```elixir

# lib/my_app_web/router.ex

live_dashboard "/dashboard",

  additional_pages: [

    oban: Oban.LiveDashboard

  ]

```

Then restart the server and access `/dashboard/oban`.