DevJoghurt / nuxt-queue

Nuxt module that adds support for queue managing and build process for worker based on BullMQ

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Nuxt Queue Module

BullMQ integration for Nuxt. Comes with an API for the programmatic management of queues and workers. Offers its own user interface based on @nuxt/ui, which can be integrated as a component.

This module offers a dedicated build process for running and scaling workers in seperate processes on the server. Nethertheless it is deep integrated with the Nuxt framework to achive a great developer usability.

✅ Status

Currently in developing mode, wip.

🚀 Usage

Install

  1. Add the following line to the devDependencies with your package manager:
npx nuxi@latest module add nuxt-queue
  1. Add nuxt-queue to the modules section of nuxt.config.ts
{
  modules: [
    'nuxt-queue',
  ],
}

Settings

The queue UI components can be enabled by setting config queue.ui to true.

{
  queue: {
    ui: true,
  },
}

As the UI components are based on @nuxt/ui, you have to install this module seperatley and add it to nuxt.config.

{
  modules: [
    'nuxt-queue'
    '@nuxt/ui',
  ],
}

Since this module uses the tailwindcss:config hook, it must be registered before @nuxt/ui.

Use the component in your application:

<template>
  <div>
    <QueueApp />
  </div>
</template>

ROADMAP

  • Add more features to UI
  • Save memory by not loading queue instances in memory
  • Flow support + UI (Vue Flow)

©️ License

MIT License - Copyright (c) DevJoghurt

About

Nuxt module that adds support for queue managing and build process for worker based on BullMQ

License:MIT License


Languages

Language:TypeScript 71.4%Language:Vue 27.3%Language:JavaScript 0.7%Language:Shell 0.7%