kanbanqube 1.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,287 @@
+# KanbanQube
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=mathiasconradt_kanbanqube&metric=alert_status&token=7c0afec22581861a3d7d49e67df8ad32aa9b5972)](https://sonarcloud.io/summary/new_code?id=mathiasconradt_kanbanqube)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](LICENSE)
+[![Buy me a coffee](https://img.shields.io/badge/Buy%20me-a%20coffee-ff5f5f?logo=ko-fi&logoColor=white)](https://ko-fi.com/mathiasconradt)
+![GitHub stars](https://img.shields.io/github/stars/mathiasconradt/kanbanqube)
+
+![KanbanQube preview](promo.jpg)
+
+KanbanQube is a local-first Kanban board app backed by normal files in a vault folder. It is designed for personal or team workflows where the board should live in a regular directory, optionally inside a Git repository, so changes can be versioned and synced with the tools you already use.
+
+The app provides lanes, cards, labels, checklists, comments, card covers, file attachments, archived cards, search, and a card-detail view. Uploaded files are stored in an `uploads/` folder, while board data is split into per-object JSON files under `board/` so Git can merge independent card and checklist edits more cleanly.
+
+![KanbanQube board screenshot](screenshot.png)
+
+## Table Of Contents
+
+- [Requirements](#requirements)
+- [Run With npx](#run-with-npx)
+- [Install](#install)
+- [Homebrew](#homebrew)
+- [Build](#build)
+- [Vaults](#vaults)
+- [Board Workflow](#board-workflow)
+- [Git Sync](#git-sync)
+- [Import](#import)
+- [Demo Board](#demo-board)
+- [Identity](#identity)
+- [Attachments And Covers](#attachments-and-covers)
+- [Keyboard Shortcuts](#keyboard-shortcuts)
+- [Development](#development)
+- [Release Automation](#release-automation)
+- [Star History](#star-history)
+
+## Requirements
+
+- Node.js 18 or newer
+- Git, if you want repository sync
+- A folder to use as your board vault
+
+## Run With npx
+
+Run KanbanQube against a vault folder:
+
+```sh
+npx kanbanqube /path/to/your/vault
+```
+
+Then open:
+
+```text
+http://localhost:3000
+```
+
+If no path is provided, KanbanQube uses the current working directory as the vault:
+
+```sh
+npx kanbanqube
+```
+
+You can choose a different port:
+
+```sh
+PORT=4000 npx kanbanqube /path/to/your/vault
+```
+
+## Install
+
+Global install:
+
+```sh
+npm install -g kanbanqube
+kanbanqube /path/to/your/vault
+```
+
+Local development install from this repository:
+
+```sh
+npm install
+npm start -- /path/to/your/vault
+```
+
+## Homebrew
+
+Install from the project tap:
+
+```sh
+brew tap mathiasconradt/kanbanqube https://github.com/mathiasconradt/kanbanqube
+brew install kanbanqube
+kanbanqube /path/to/your/vault
+```
+
+KanbanQube currently installs as a Homebrew formula for the Node.js command-line server, not as a macOS app cask. If a future app cask or manual macOS app zip is added, the cask should remove the macOS quarantine attribute during install. If you download an app release zip manually and macOS says the app is damaged, run:
+
+```sh
+xattr -cr "/Applications/KanbanQube.app"
+```
+
+## Build
+
+KanbanQube has no frontend build step. The app is plain Node.js plus static browser assets.
+
+Validate the server and browser JavaScript:
+
+```sh
+npm test
+```
+
+Package managers can install it directly because `package.json` exposes the `kanbanqube` executable through the `bin` field.
+
+## Vaults
+
+A vault is just a directory. KanbanQube stores:
+
+```text
+vault/
+  board/
+    meta.json
+    cards/
+    lists/
+    checklists/
+    actions/
+    labels/
+    members/
+  uploads/
+```
+
+If `board/` does not exist, KanbanQube creates it automatically. If an older `board.json` exists, KanbanQube imports it into the split `board/` layout the first time it starts. The original `board.json` is left in place but is no longer the active storage file. If `uploads/` does not exist, it is created when the first file is uploaded.
+
+Uploaded filenames are made unique while preserving the original name in the UI. For example:
+
+```text
+MyExample.png
+MyExample.kbq_20260609T092141981Zb7a252.png
+```
+
+The stored filename prevents conflicts. The app still displays `MyExample.png`.
+
+## Board Workflow
+
+Use the board view for quick work:
+
+- Click `+ Add a card` to create a card directly in the lane and type its title inline.
+- Click the board title or lane title to rename it inline.
+- Click a card to open its details.
+- Settings can enable inline editing for existing card titles in board lanes.
+
+## Git Sync
+
+Git sync is optional. If the vault is a Git repository with a configured `origin` remote, the Sync button is enabled.
+
+When Sync runs, KanbanQube:
+
+1. Saves pending board changes.
+2. Checks whether anything in the vault repository changed.
+3. Stages and commits all repository changes when needed, including `board/`, `uploads/`, and newly added files.
+4. Runs `git pull --rebase` to bring in remote changes after local work is committed.
+5. Pushes to the configured remote.
+6. Reloads the board from disk so changes pulled from another machine are visible without refreshing the browser.
+
+If the vault is not a Git repository, or no remote is configured, Sync stays disabled. You can still use the board locally.
+
+Settings includes `Run Git sync in the background (no dialog)`. When enabled, the Sync button runs without opening the sync log automatically. The status text under the app title can still be clicked to open the sync log during or after sync.
+
+Recommended setup:
+
+```sh
+mkdir my-kanban-vault
+cd my-kanban-vault
+git init
+git remote add origin git@github.com:you/my-kanban-vault.git
+npx kanbanqube .
+```
+
+Commit and push once if your remote requires an initial branch:
+
+```sh
+git add board
+git commit -m "Initialize KanbanQube board"
+git push -u origin main
+```
+
+## Import
+
+KanbanQube can import a board export JSON from Settings. Import is only enabled when the current board has no cards. This keeps accidental replacement of an active board from happening inside the app.
+
+Imported data is normalized and written into the split `board/` vault layout.
+
+## Demo Board
+
+The repository includes `demo_board.json`, a sample e-commerce product board with design, UX, frontend, backend, QA, content, and analytics work spread across the default lanes.
+
+When a vault has no cards, KanbanQube asks whether to load the demo board. If accepted, the app loads `demo_board.json` and saves it into the current vault using the same path as a normal import.
+
+## Identity
+
+KanbanQube reads your Git identity from the vault repository first:
+
+```sh
+git config --local user.name
+git config --local user.email
+```
+
+If local values are missing, it falls back to global Git config:
+
+```sh
+git config --global user.name
+git config --global user.email
+```
+
+That name is used for comments and activity entries. The settings dialog shows the detected name and email as read-only values.
+
+## Attachments And Covers
+
+Drop files onto a card or into the card details view to attach them. Files are uploaded into the vault `uploads/` folder.
+
+Images can be used as card covers. The cover is stored as a pointer to the attachment in `card.cover.idAttachment`, so removing a cover does not delete the attachment. You can also select another image attachment as the cover.
+
+Deleting an uploaded attachment from a card also deletes the physical file from `uploads/` when no other card still references that file.
+
+## Keyboard Shortcuts
+
+Board view shortcuts are ignored while typing in inputs or while a dialog is open.
+
+| Key | Action |
+| --- | --- |
+| Arrow keys | Select cards across lanes and rows |
+| Enter | Open selected card details |
+| Space | Toggle selected card done status |
+| c | Archive selected card |
+| 1-9 | Toggle the matching label by label-list order |
+
+## Development
+
+Start the app from the repository:
+
+```sh
+npm start -- /path/to/your/vault
+```
+
+Run checks:
+
+```sh
+npm test
+```
+
+Main files:
+
+- `server.js` - HTTP server, vault storage, upload handling, Git sync
+- `public/app.js` - board UI behavior
+- `public/styles.css` - app styling
+- `public/index.html` - static app shell
+
+## Release Automation
+
+KanbanQube is prepared for npm and Homebrew releases.
+
+For `npx`, the package is published to npm as `kanbanqube` under the npm account `mathiasconradt`. The package exposes the `kanbanqube` executable through `package.json`.
+
+Required GitHub secrets:
+
+- `NPM_TOKEN` - npm automation token for publishing `kanbanqube`
+
+Release flow:
+
+1. A non-bot push to `main` runs the version bump workflow.
+2. The workflow bumps the patch version in `package.json` and `package-lock.json`.
+3. It updates the Homebrew formula version and pushes a matching `vX.Y.Z` tag.
+4. The release workflow runs for that tag.
+5. It runs tests, publishes to npm, creates the npm tarball release asset, and updates the Homebrew formula SHA on `main`.
+
+After release, users can run:
+
+```sh
+npx kanbanqube /path/to/your/vault
+brew install mathiasconradt/kanbanqube/kanbanqube
+```
+
+## Star History
+
+<a href="https://www.star-history.com/?repos=mathiasconradt%2Fkanbanqube&type=timeline&logscale=&legend=top-left">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/chart?repos=mathiasconradt/kanbanqube&type=timeline&theme=dark&logscale&legend=top-left" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/chart?repos=mathiasconradt/kanbanqube&type=timeline&logscale&legend=top-left" />
+   <img alt="Star History Chart" src="https://api.star-history.com/chart?repos=mathiasconradt/kanbanqube&type=timeline&logscale&legend=top-left" />
+ </picture>
+</a>