Files
WorkspaceOrg/README.md

77 lines
4.0 KiB
Markdown
Raw Permalink Normal View History

# WorkspaceOrg -- group your projects into personal workspaces
A small Kanboard plugin that lets each user file their projects into their own named
**workspaces** (think folders: "UNIBRA", "UPE", "Home"), and see them grouped on a
**My workspaces** dashboard page. Kanboard's project list is otherwise flat -- this gives you
structure without touching how projects themselves work.
Everything is **per user**: your workspaces and how you file your projects are yours alone.
Two people can file the same shared project differently, and neither sees the other's grouping.
## What it does
- Adds a **My workspaces** entry to the dashboard sidebar (next to Overview / My projects /
My tasks / My subtasks). Visible to every logged-in user -- no admin rights needed.
- That page lists your projects **grouped by workspace** (each heading shows the project count,
e.g. `POLI/UPE (3)`), with each row showing the project **id**, **title** and **owner**, plus a
small id dropdown with a "Configure this project" shortcut. From it you can:
- **add / rename / remove** workspaces (each via a small modal, like Kanboard's Tags page);
- **move a project** to another workspace with an inline dropdown on its row.
- Shows a **`[Workspace]`** badge before the project title on the dashboard overview, the
dashboard "My projects" tab, and the Projects management list -- so you can see at a glance
where each project is filed.
## The "Default" workspace
Every project starts in **Default**, which is simply "not filed yet". Default is not a real
stored workspace -- it is the leftover bucket -- so it can never be renamed or removed, and it
always sorts last. Projects in Default show **no badge** (to keep unfiled projects clean).
Removing a workspace moves its projects back to Default; it never deletes anything.
## Ordering
On the My workspaces page, workspaces are listed alphabetically (A-Z) with Default last, and the
projects within each workspace are alphabetical too.
## How it stores data
No database migration. Everything lives in **user metadata**: your workspace names
(`workspaceorg_names`) and your project-to-workspace map (`workspaceorg_map`), both as JSON.
Nothing is global and nothing touches the projects themselves -- uninstalling the plugin leaves
that metadata harmlessly in place and changes nothing about your projects.
## Requirements
- Kanboard >= 1.2.0
## Installation
Copy this folder into your Kanboard installation as `plugins/WorkspaceOrg/`. The directory name
must be exactly `WorkspaceOrg` (Kanboard derives the plugin namespace from the folder name). No
build step and no database migration. Reload, then open **My workspaces** from the dashboard.
## License
AGPL-3.0. See LICENSE.
2026-07-13 08:56:00 -03:00
## More Kanboard plugins by Dr. Beco
All free and AGPL-3.0, at [code.beco.cc](https://code.beco.cc/beco):
- **[RecoReco](https://code.beco.cc/beco/RecoReco)** -- calendar-scheduled recurring cards (yearly,
monthly, weekly, daily), driven by the card due date.
- **[FinanceBuddy](https://code.beco.cc/beco/FinanceBuddy)** -- attach a money value (debit/credit
and installments) to cards, shown on the card and totalled per column.
- **[QualKard](https://code.beco.cc/beco/QualKard)** -- flashcard spaced repetition: grade a card by
dragging it to a column, and it comes back when due (needs RecoReco).
- **[OrganonTweaks](https://code.beco.cc/beco/OrganonTweaks)** -- an umbrella of small
quality-of-life board tweaks: remove an empty column, always show the comment icon, emphasize due
dates, extra search keywords and shared board filters, and more.
- **[BulkMoveTasks](https://code.beco.cc/beco/BulkMoveTasks)** -- move every task from one board
column to another in a single action.
- **[ShrinkVertically](https://code.beco.cc/beco/ShrinkVertically)** -- shrink vertically-collapsed
board columns so the horizontal scrollbar stays within reach.
- **[TweakDrag](https://code.beco.cc/beco/TweakDrag)** -- board drag and touch niceties:
drag-to-scroll, a wider column gap, and smoother card dragging.