npmpackage.info

Gathering detailed insights and metrics for bull-board

Other packages similar to bull-board

@bull-board/ui

6.7.7

A Dashboard UI built on top of bull or bullmq.

@bull-board/api

6.7.7

A Dashboard server API built on top of bull or bullmq.

@bull-board/express

6.7.7

A Express.js server adapter for Bull-Board dashboard.

@midwayjs/bull-board

3.20.2

midway component for bull

bull-board

🎯 Queue background jobs inspector

2.1.3

2,505

MIT

TypeScript

246.87 kB

6,672,148 4.4

Installations

npm install bull-board

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.16.0

NPM Version

7.13.0 Score

81.8

Supply Chain

95.3

Quality

76.2

Maintenance

Vulnerability

87.6

License

Pull Requests

Open

6

Total

467

Closed

75

Merged

386

Issues

Open

34

Total

426

Closed

392

Releases

209

Release 6.7.7

v6.7.7

Updated on Feb 09, 2025

Release 6.7.6

v6.7.6

Updated on Feb 09, 2025

Release 6.7.5

v6.7.5

Updated on Feb 09, 2025

Release 6.7.4

v6.7.4

Updated on Jan 30, 2025

Release 6.7.3

v6.7.3

Updated on Jan 30, 2025

Release 6.7.2

v6.7.2

Updated on Jan 29, 2025

View All 209 releases

Contributors

View All 85 Contributors

Languages

TypeScript

CSS

JavaScript

EJS

Dockerfile

TypeScript (83.98%)

CSS (14.87%)

JavaScript (0.81%)

EJS (0.28%)

Dockerfile (0.06%)

Love this project? Help keep it running — sponsor us today! 🚀

Developer

felixmosh

Download Statistics

Total Downloads

6,672,148

Last Day

1,452

Last Week

25,841

Last Month

96,313

Last Year

1,067,299

GitHub Statistics

MIT License

2,505 Stars

1,053 Commits

380 Forks

14 Watchers

47 Branches

85 Contributors

Updated on Feb 15, 2025

Bundle Size

623.95 kB

Minified

246.87 kB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

2.1.3

Package Id

bull-board@2.1.3

Size

117.71 kB

NPM Version

7.13.0

Node Version

14.16.0

Published on

Jun 28, 2021

Total Downloads

Cumulative downloads

Total Downloads

6,672,148

Last Day

-14.3%

1,452

Compared to previous day

Last Week

8.1%

25,841

Compared to previous week

Last Month

20.8%

96,313

Compared to previous month

Last Year

7.9%

1,067,299

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/express @types/express-serve-static-core ejs express redis-info

Dev Dependencies

@babel/core @babel/plugin-proposal-class-properties @babel/plugin-proposal-object-rest-spread @babel/plugin-transform-runtime @babel/preset-env @babel/preset-react @babel/preset-typescript @babel/runtime @pmmmwh/react-refresh-webpack-plugin @types/bull @types/classnames @types/ioredis @types/jest @types/node @types/pretty-bytes @types/react-dom @types/react-highlight @types/react-router-dom @types/redis-info @types/supertest @typescript-eslint/eslint-plugin @typescript-eslint/parser @typescript-eslint/typescript-estree auto-changelog axios babel-loader bull bullmq clsx css-loader css-minimizer-webpack-plugin date-fns dockest eslint eslint-config-prettier eslint-plugin-no-only-tests eslint-plugin-react fork-ts-checker-webpack-plugin highlight.js html-webpack-plugin jest mini-css-extract-plugin postcss-loader postcss-preset-env prettier pretty-bytes react react-dev-utils react-dom react-refresh react-router-dom react-toastify release-it style-loader supertest ts-jest ts-node-dev typescript webpack webpack-cli webpack-dev-server

bull-board ????

Bull Dashboard is a UI built on top of Bull or BullMQ to help you visualize your queues and their jobs. With this library you get a beautiful UI for visualizing what's happening with each job in your queues, their status and some actions that will enable you to get the job done.

Fails

DEPRECATED

We moved to be served under @bull-board npm scope.

Notes

As this library provides only the visualization for your queues, keep in mind that:

You must have either Bull or BullMQ installed in your projects;
Aside the options to retry and clean jobs, this library is not responsible for processing the jobs, reporting progress or any other thing. This must be done in your application with your own logic;
If you want to understand the possibilities you have with the queues please refer to Bull's docs;
This library doesn't hijack Bull's way of working.

If you want to learn more about queues and Redis: https://redis.io/.

Starting

To add it to your project start by adding the library to your dependencies list:

1yarn add bull-board

1npm i bull-board

Hello World

The first step is to setup bull-board by calling createBullBoard method.

1const express = require('express')
2const Queue = require('bull')
3const QueueMQ = require('bullmq')
4const { createBullBoard } = require('bull-board')
5const { BullAdapter } = require('bull-board/bullAdapter')
6const { BullMQAdapter } = require('bull-board/bullMQAdapter')
7
8const someQueue = new Queue('someQueueName')
9const someOtherQueue = new Queue('someOtherQueueName')
10const queueMQ = new QueueMQ('queueMQName')
11
12const { router, setQueues, replaceQueues, addQueue, removeQueue } = createBullBoard([
13  new BullAdapter(someQueue),
14  new BullAdapter(someOtherQueue),
15  new BullMQAdapter(queueMQ),
16])
17
18const app = express()
19
20app.use('/admin/queues', router)
21
22// other configurations of your server

That's it! Now you can access the /admin/queues route, and you will be able to monitor everything that is happening in your queues ????

For more advanced usages check the examples folder, currently it contains:

Queue options

readOnlyMode (default: false) Makes the UI as read only, hides all queue & job related actions

1const Queue = require('bull')
2const QueueMQ = require('bullmq')
3const { setQueues } = require('bull-board')
4const { BullMQAdapter } = require('bull-board/bullMQAdapter')
5const { BullAdapter } = require('bull-board/bullAdapter')
6
7const someQueue = new Queue()
8const someOtherQueue = new Queue()
9const queueMQ = new QueueMQ()
10
11const { router, setQueues, replaceQueues } = createBullBoard([
12  new BullAdapter(someQueue, { readOnlyMode: true }), // only this queue will be in read only mode
13  new BullAdapter(someOtherQueue),
14  new BullMQAdapter(queueMQ, { readOnlyMode: true }),
15])

Hosting router on a sub path

If you host your express service on a different path than root (/) ie. https://<server_name>/<sub_path>/, then you can add the following code to provide the configuration to the bull-board router. In this example the sub path will be my-base-path.

1const Queue = require('bull')
2const { createBullBoard } = require('bull-board')
3const { BullAdapter } = require('bull-board/bullAdapter')
4
5const someQueue = new Queue('someQueueName')
6
7const { router } = createBullBoard([
8  new BullAdapter(someQueue),
9])
10
11// ... express server configuration
12
13let basePath = 'my-base-path';
14
15app.use(
16  '/queues',
17  (req, res, next) => {
18    req.proxyUrl = basePath + '/queues';
19    next();
20  },
21  router);

You will then find the bull-board UI at the following address https://<server_name>/my-base-path/queues.

Contributing

First, thank you for being interested in helping out, your time is always appreciated in every way. ????

Remember to read the Code of Conduct so you also help maintaining a good Open source community around this project!

Here are some tips:

Check the issues page for already opened issues (or maybe even closed ones) that might already address your question/bug/feature request.
When opening a bug report provide as much information as you can, some things might be useful for helping debugging and understading the problem
- Node, Redis, Bull, bull-board versions
- Sample code that reproduces the problem
- Some of your environment details
- Framework you're using (Express, Koa, Hapi, etc).
Feature requests are welcomed! Provide some details on why it would be helpful for you and others, explain how you're using bull-board and if possible even some screenshots if you are willing to mock something!

Developing

If you want to help us to solve the issues, be it a bug, a feature or a question, you might need to fork and clone this project.

To fork a project means you're going to have your own version of it under your own GitHub profile, you do it by clicking the "Fork" button on the top of any project's page on GitHub.

Cloning a project means downloading it to your local machine, you do it in the command line:

1git clone git@github.com:YOUR_GITHUB_USERNAME/bull-board.git

That will create a bull-board folder inside the directory you executed the command, so you need to navigate inside it:

1cd bull-board

This project requires that you have yarn installed

Also make sure you are running Redis for this project (bull-board's example connects to Redis' default port 6379).

Now, to try it out locally you can run:

1yarn && yarn start:dev

Acknowledgements ❤️

Juan for building the first version of this library

License

This project is licensed under the MIT License, so it means it's completely free to use and copy, but if you do fork this project with nice additions that we could have here, remember to send a PR ????

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

8

SAST

Determines if the project uses static code analysis.

1

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.4

/10

Last Scanned on 2025-02-10

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More