✨feature: Initial MVP
This commit is contained in:
@@ -0,0 +1,37 @@
|
||||
# IronKanban
|
||||
|
||||
IronKanban is a lightweight PHP and vanilla JavaScript app for managing markdown-backed projects as a kanban board. It keeps project notes and tasks as flat files, stores board column configuration in `board.md`, and updates the filesystem whenever cards are moved or edited.
|
||||
|
||||
## Features
|
||||
|
||||
- Git-backed markdown storage under `storage/projects` by default
|
||||
- Server-rendered project view with dark responsive UI
|
||||
- SortableJS drag-and-drop for columns and task cards
|
||||
- Sparse integer ordering with rebalance support
|
||||
- Task create, edit, move, trash, and permanent delete flows
|
||||
- Note create and edit flow
|
||||
- Revision file polling for real-time-ish refreshes
|
||||
- Best-effort git commits after project changes
|
||||
- Sensible default columns for brand-new projects: Backlog, Ready, In Progress, Review, Done, and Trash
|
||||
|
||||
## Project Layout
|
||||
|
||||
```plain
|
||||
storage/projects/{projectSlug}/
|
||||
├── index.md
|
||||
├── board.md
|
||||
├── notes/
|
||||
│ └── *.md
|
||||
└── tasks/
|
||||
└── *.md
|
||||
```
|
||||
|
||||
## Running Locally
|
||||
|
||||
```bash
|
||||
php -S localhost:8000 -t public
|
||||
```
|
||||
|
||||
Then open `http://localhost:8000`.
|
||||
|
||||
To point at a different projects directory, set `IKB_PROJECT_ROOT`.
|
||||
Reference in New Issue
Block a user