yashs662 / rust_kanban

A kanban board for the terminal built with ❤️ in Rust
https://crates.io/crates/rust-kanban
MIT License
186 stars 18 forks source link
hacktoberfest kanban rust tui

License Build Issues Crates.io Downloads Stars rust_kanban

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

Completed Features

Known Issues

PSA (i.e. Public service announcement)

How to use

Default Keybindings

Keybinding Action
'Ctrl + c' or 'q' Quit
'Tab' Next Focus
'BackTab' Previous Focus
'c' Configure
'Up' Move Up
'Down' Move Down
'Right' Move Right
'Left' Move Left
'i' Take User Input (when filling out a form)
'Insert' Exit user input mode
'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
'4' Change Card Priority to High
'5' Change Card Priority to Medium
'6' Change Card Priority to Low
'r' Reset UI to Default
'm' Go to Main Menu
'Ctrl + p' Toggle Command Palette
'Esc' Go to Previous View
't' Clear Toast Messages
'Mouse Left Click' Select UI Element
'Mouse Middle Click' Open Command Palette
'Mouse Right Click' Go to Previous View
'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)
'Ctrl + z' Undo
'Ctrl + y' Redo

Available Themes