Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iamriteshkoushik/go-cli-kanban
TUI Kanban Board built with Charm packages in Go.
https://github.com/iamriteshkoushik/go-cli-kanban
cli-app golang kanban-board tui
Last synced: 1 day ago
JSON representation
TUI Kanban Board built with Charm packages in Go.
- Host: GitHub
- URL: https://github.com/iamriteshkoushik/go-cli-kanban
- Owner: IAmRiteshKoushik
- Created: 2024-01-02T16:15:21.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-18T09:59:36.000Z (3 months ago)
- Last Synced: 2024-08-19T08:37:28.866Z (3 months ago)
- Topics: cli-app, golang, kanban-board, tui
- Language: Go
- Homepage:
- Size: 67.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CLI - Kanban Board
## Overview
This is a simple kanban board for the CLI written in Go with the help of
[Bubble Tea](https://github.com/charmbracelet/bubbletea) TUI-framework,
[Bubbles](https://github.com/charmbracelet/bubbles) components-library and
[Lipgloss](https://github.com/charmbracelet/lipgloss) styling definition from
[Charm.sh](https://charm.sh/).
## Setup and Installation
Make sure to have Go v1.18 or higher installed on your system for this program
to run.
```bash
# Using the Git CLI
git clone https://github.com/IAmRiteshKoushik/go-cli-kanban
# (or) Using the GitHub CLI
gh repo clone IAmRiteshKoushik/go-cli-kanban
```
Installation of necessary modules
```bash
# Fetching all modules
go mod tidy
# Running the program
go run .
```
## Usage Instructions
```bash
# Move left
> h (key)
# Move right
> l (key)
# Complete task
> Enter (key)
# Create task
> n (key)
# Quit the program
> q
```
## Existing features:
- [X] Create a task in any list - Not Started, In Progress, Done
- [X] Move tasks between lists
## Some good extensions
- [ ] Add filtering functionality within lists `(bug-fix)`
- [ ] If a list becomes empty, the program crashes `(fix)`
- [ ] Convert the CLI to a TUI for better navigation `(feat)`
- [ ] Add a database for persistance of todos. `(feat)`