51 lines
1.9 KiB
Markdown
51 lines
1.9 KiB
Markdown
# FinanceBuddy -- money on your Kanboard cards
|
|
|
|
Attach a money value to a board card, see it on the card, and total it per column -- so a
|
|
Kanboard project can double as a simple, visual finance board (bills, installments, income
|
|
vs expenses).
|
|
|
|
FinanceBuddy is **opt-in per board**: installing it changes nothing until a project manager
|
|
enables it for a specific board under Settings -> Integrations. Boards that are not enabled
|
|
look exactly as before.
|
|
|
|
## The idea: a bill-lifecycle board
|
|
|
|
Kanboard imposes no structure, so FinanceBuddy is built to fit one rather than dictate it. The
|
|
suggested organization:
|
|
|
|
- **Columns = a bill's status:** `Templates -> Due this month -> Paid`. Cards flow left to
|
|
right as they are paid.
|
|
- **Tags = category:** housing, utilities, comms, food...
|
|
- **Due date = the bill's due date;** color/priority = urgency.
|
|
- Each card carries a **money value** (debit or credit) and, optionally, an **installment**
|
|
count (`p2/10` = 2nd of 10 payments; leave the total blank for an open-ended recurring bill).
|
|
|
|
Recurring monthly bills can live as template cards spawned each month by the companion RecoReco
|
|
plugin; FinanceBuddy only owns the money.
|
|
|
|
## Money format
|
|
|
|
Amounts are shown in R$ with a comma decimal and no thousand separator (for example
|
|
`R$1234,56`). Input accepts either a dot or a comma as the decimal separator, so `1234.56` and
|
|
`1234,56` are the same value.
|
|
|
|
## Status
|
|
|
|
Early development. This version registers the plugin and loads its stylesheet; the per-board
|
|
toggle, the in-form editing, the card badge, and the per-column totals arrive in the following
|
|
versions.
|
|
|
|
## Requirements
|
|
|
|
- Kanboard >= 1.2.0
|
|
|
|
## Installation
|
|
|
|
Copy this folder into your Kanboard installation as `plugins/FinanceBuddy/`. The directory name
|
|
must be exactly `FinanceBuddy` (Kanboard derives the plugin namespace from the folder name). No
|
|
build step and no database migration.
|
|
|
|
## License
|
|
|
|
AGPL-3.0. See LICENSE.
|