#tui #kanban #cli #terminal

bin+lib rust-kanban

A kanban board for the terminal built with ❤️ in Rust

12 releases

new 0.5.1 Mar 15, 2023
0.5.0 Mar 14, 2023
0.4.1 Mar 7, 2023
0.3.8 Mar 1, 2023
0.3.7 Feb 26, 2023

#37 in Text editors

Download history 120/week @ 2023-02-12 26/week @ 2023-02-19 64/week @ 2023-02-26 30/week @ 2023-03-05 42/week @ 2023-03-12

181 downloads per month

MIT/Apache

590KB
13K SLoC

Crates.io

Kanban App for the terminal written in rust

This kanban app will allow the user to be more productive by prioritizing tasks and achieving goals faster

Why?

I am new to rust and wanted to learn the language in a project-oriented manner, feel free to drop feedback on my code😁. Another reason for building a TUI is that I spend the majority of my time in the terminal whether it is testing or running code or writing code in neovim. I haven't been able to find any other alternatives so I have started to make my own!

Contribution

Feel free to make a pull request or make a new issue, I am open to suggestions ✌️ I currently do not own a Mac so I am unable to test the app on Mac, if you can test it on Mac, please let me know if there are any issues.

TODO

  • Allow for more mouse Interactions (Dragging cards maybe?)
  • Allow Card to be modified in Card View
  • Implement Cloud saves (Google drive maybe? as I am not going to host a server)
  • Implement animations for UI elements
  • Implement a way to sync with other services like notion
  • Write Tests
  • Add a Tutorial for new users (Preferably in the app itself with animations and highlighting of UI elements)

Completed Features

  • Implement a way to add custom colors (Theme support)
  • Implement a way to interact with the kanban board using the mouse (Clicking, Scrolling are supported as of now)
  • Added ability to export kanban data to JSON
  • Implement a Command Palette (like in vs code (Ctrl + Shift + P)) as a way to interact with the app instead of using keybindings
  • Implement previews for loading a save
  • Toast Message Implementation -- (Inspired by nvim-notify)
  • Improve Help Messages
  • Custom Keybindings
  • Implement the Kanban Boards ( the main UI basically )
  • Auto Save on exit
  • Save/Load Kanban state
  • Hide/Unhide UI elements
  • Refactoring UI Logic
  • Focusing and highlighting UI elements
  • Input Handling
  • Logging

Known Issues

None as of now, please let me know if you find any bugs

How to use

Default Keybindings

Keybinding Action
'Ctrl + c' or 'q' Quit
'Tab' Next Focus
'BackTab' Previous Focus
'c' Open Config Menu
'Up' Move Up
'Down' Move Down
'Right' Move Right
'Left' Move Left
'i' Take User Input (when filling out a form)
'h' Hide UI Element
'Ctrl + s' Save State
'b' New Board
'n' New Card
'd' Delete Card
'D' or 'Shift + d' Delete Board
'1' Change Card Status to Completed
'2' Change Card Status to Active
'3' Change Card Status to Stale
'r' Reset UI to Default
'm' Go to Main Menu
'Ctrl + p' Toggle Command Palette
'Esc' Go to Previous UI Mode
't' Clear Toast Messages
'Mouse Left Click' Select UI Element
'Mouse Middle Click' Open Command Palette
'Mouse Right Click' Go to Previous UI Mode
'Mouse Scroll Up' Scroll Up Cards
'Mouse Scroll Down' Scroll Down Cards (for cards)
'Ctrl + Mouse Scroll Up' Scroll to the right (for boards)
'Ctrl + Mouse Scroll Down' Scroll to the left (for boards)

Screenshots

rust_kanban

Dependencies

~17–23MB
~279K SLoC