https://github.com/nikku/wuffle

A multi-repository / multi-organization task board for GitHub issues.
https://github.com/nikku/wuffle

github-app issues kanban-board probot-app project-management task-board

Last synced: about 2 months ago
JSON representation

A multi-repository / multi-organization task board for GitHub issues.

• Host: GitHub
• URL: https://github.com/nikku/wuffle
• Owner: nikku
• License: mit
• Created: 2019-03-20T21:45:21.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-26T19:17:02.000Z (5 months ago)
• Last Synced: 2024-05-02T00:05:21.963Z (5 months ago)
• Topics: github-app, issues, kanban-board, probot-app, project-management, task-board
• Language: JavaScript
• Homepage: https://wuffle.dev
• Size: 9.28 MB
• Stars: 116
• Watchers: 9
• Forks: 22
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Security: SECURITY.md
  • Support: support/docker/Dockerfile

Awesome Lists containing this project

• jimsghstars - nikku/wuffle - A multi-repository / multi-organization task board for GitHub issues. (JavaScript)

README

        
# Wuffle

[![CI](https://github.com/nikku/wuffle/actions/workflows/CI.yml/badge.svg)](https://github.com/nikku/wuffle/actions/workflows/CI.yml)

A multi-repository / multi-organization task board for [GitHub issues](https://guides.github.com/features/issues/).



  

    

  



[Try out Wuffle](#setup-and-run) or checkout [features](#features) and [philosophy](#philosophy) to learn more about the tool.

## Features

* Multi-repository / organization support

* Maps issues to columns via labels or close states

* [Moves cards across columns](https://github.com/nikku/wuffle/blob/main/docs/AUTOMATIC_CARD_MOVEMENT.md) automatically, as you develop

* [Filters issues](https://github.com/nikku/wuffle/blob/main/docs/BOARD_FILTERS.md) by name, label, assignee, and more

* Visualizes reviews and pull request status/checks on a card

* Supports private repositories: Visitors only see cards for issues they see on GitHub, too

* Lets you create a new issue in _any_ connected repository

* Allows contributors to move/reorder cards

* Simple setup: Connects to GitHub as a [GitHub app](https://developer.github.com/apps/)

## Resources

* [Issues](https://github.com/nikku/wuffle/issues)

* [Roadmap](https://github.com/nikku/wuffle/issues?q=is%3Aissue+is%3Aopen+label%3Aroadmap)

* [Changelog](https://github.com/nikku/wuffle/blob/main/packages/app/CHANGELOG.md)

* [Setup and Run](https://github.com/nikku/wuffle/blob/main/docs/SETUP.md)

* [Documentation](https://github.com/nikku/wuffle/tree/main/docs#readme)

## Philosophy

Some key aspects separate [Wuffle](https://github.com/nikku/wuffle) from the GitHub task board competition:

* __[GitHub issues](https://guides.github.com/features/issues/) are the source of truth.__ We read and store columns, relationships, and everything else directly on GitHub. The only exception is issue order (not supported by GitHub, so far).

* __No [projects](https://docs.github.com/en/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects), no cards.__ No secondary editing UI, no incomplete views on your backlog. Just issues, milestones, and labels, all the way.

* __Tight integration with the [GitHub flow](https://guides.github.com/introduction/flow/).__ Your issues move automatically across the board. The board is always up to date with things going on in development.

* __Publicly accessible.__ You can share your project status without restrictions. Applied board filters are shareable deep links. However, we do only display those issues to a visitor that she sees on GitHub, too. Would you like to see cards from your private repositories? Log in with your GitHub identity and see them pop up in the mapped column.

* __Hackable.__ Wuffle is open source, MIT licensed. Contribute to it to make it even better. Self-host it and stay the owner of your data.

## Setup and Run

Starting the board, including first-time setup if you have [npm](https://www.npmjs.com/) installed:

```

npx wuffle

```

Read the [setup instructions](https://github.com/nikku/wuffle/blob/main/docs/SETUP.md) for detailed explaination for the what and why.

Alternatively, start the app [via Docker](https://github.com/nikku/wuffle/tree/main/support/docker) if you already configured it.

## Components

* [board](https://github.com/nikku/wuffle/blob/main/packages/board) - the task board front-end

* [app](https://github.com/nikku/wuffle/blob/main/packages/app) - the back-end and board API

## Related

* [The making of Wuffle](https://nikku.github.io/talks/2022-making-of-wuffle/) - a talk about the tool and it's philosophy

## License

[MIT](https://github.com/nikku/wuffle/blob/main/LICENSE)