https://github.com/alcb1310/kanban
CLI tool to manage Kanban boards
https://github.com/alcb1310/kanban
bubbletea charm charmbracelet cli cobra go sqlite3 tools
Last synced: 5 months ago
JSON representation
CLI tool to manage Kanban boards
- Host: GitHub
- URL: https://github.com/alcb1310/kanban
- Owner: alcb1310
- License: mit
- Created: 2024-03-01T22:26:23.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-03-03T17:01:48.000Z (over 2 years ago)
- Last Synced: 2024-06-21T08:22:30.224Z (almost 2 years ago)
- Topics: bubbletea, charm, charmbracelet, cli, cobra, go, sqlite3, tools
- Language: Go
- Homepage:
- Size: 131 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kanban App
## Preview
https://github.com/alcb1310/kanban/assets/97707578/ccd44f5f-be72-44d2-816f-c5f817c5599e
## Description
This is an application that will allow you to create and manage a kanban board.
## Installation
### Using Homebrew
To install the project using *Homebrew*:
```bash
brew tap alcb1310/alcb1310
brew install kanban
```
### Upgrade
To upgrade from a previous version of the project using *Homebrew*:
```bash
brew update && brew upgrade kanban
```
### Build Steps
#### Prerequisites
- Go - [https://golang.org](https://golang.org)
- Git - [https://git-scm.com](https://git-scm.com)
#### Installation
To install the project, first clone the repository.
```bash
cd ~
git clone https://github.com/alcb1310/kanban
cd kanban
```
To build the project:
```bash
go build main.go
```
To install the project:
```bash
go install main.go
```
## Usage
To run the application:
```bash
kanban
```
- To select an item within a list:
- Press the down arrow key or j to select the next item
- Press the up arrow key or k to select the previous item
- To move an item to the next list:
- Press the right arrow key or l to move the item to the next list
- Press the left arrow key or h to move the item to the previous list
- To change an item from one list to another press the space bar
- To create a new todo item press n
- To exit the application press ctrl+c
- To display the help message in the command prompt run `kanban -h` or `kanban --help`
## Tech Stack
- [Bubble Tea](https://github.com/charmbracelet/bubbletea)
- [Lipgloss](https://github.com/charmbracelet/lipgloss)
## License
MIT