Sha256: 233f58e6aabbaeae15f6bef0abf69419b3a2664cb36516b5db1e08ccc832ae7f

Contents?: true

Size: 1.92 KB

Versions: 1

Compression:

Stored size: 1.92 KB

Contents

# Solid Queue Dashboard

<p align="center">
  <a href="https://github.com/akodkod/solid-queue-dashboard#gh-light-mode-only">
    <img src="https://github.com/user-attachments/assets/90cb68cf-73d9-41bf-b9d5-93da7c36f204" alt="Solid Queue Dashboard Light Mode">
  </a>
  <a href="https://github.com/akodkod/solid-queue-dashboard#gh-dark-mode-only">
    <img src="https://github.com/user-attachments/assets/ea089277-67fc-4bc9-91d8-2e3e7349b0c9" alt="Solid Queue Dashboard Dark Mode">
  </a>

  _👋 I'm available for hire → [kodkod.me](https://kodkod.me)_
</p>

## Features
- 🎨 Beautiful UI
- 🧠 Smart status detection
- 📊 Track failure rates
- 💀 Find dead processes
- 📜 View execution history
- 🔍 Filter options
- 🔄 Retry jobs from the UI
- đŸšĢ No dependencies
- 🐒 No monkey patching

## Roadmap
- 🏊‍♂ī¸ Auto-pooling
- 📈 Add charts
- 🚀 Manually trigger jobs
- ⏚ī¸ Cancel long jobs (if possible)
- 📊 More statistics and insights
- 🔎 Search feature
- đŸ”ĸ Sorting options
- 🏗ī¸ Add tests

## Installation

To install, run this command in your terminal:

```bash
bundle add solid_queue_dashboard
```

Or add this line to your `Gemfile`:

```bash
gem "solid_queue_dashboard", "~> 0.1.0"
```

Add this line to `routes.rb`:

```ruby
mount SolidQueueDashboard::Engine, at: "/solid-queue"
```

**IMPORTANT: Protect your SolidQueueDashboard with authentication to prevent unauthorized access.**

For example, if using Devise:

```ruby
Rails.application.routes.draw do
  authenticate :current_admin do
    mount SolidQueueDashboard::Engine, at: "/solid-queue"
  end
end
```

## Contributing

After cloning the repo, run:

```
./bin/setup
./bin/setup-test-app
```

To run the test application:

```
gem install foreman
./bin/dev
```

To generate dummy data:

```
cd test_app
rails jobs:generate_dummy_data
./bin/jobs
```

## License

This gem is open source under the [MIT License](http://opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
solid_queue_dashboard-0.1.0 README.md