Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/longnghia/todo-tui
Todo TUI app, vim like
https://github.com/longnghia/todo-tui
todo tui vim
Last synced: 3 months ago
JSON representation
Todo TUI app, vim like
- Host: GitHub
- URL: https://github.com/longnghia/todo-tui
- Owner: longnghia
- License: mit
- Created: 2024-08-21T16:56:14.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-09-15T08:28:28.000Z (5 months ago)
- Last Synced: 2024-10-18T08:43:19.720Z (4 months ago)
- Topics: todo, tui, vim
- Language: Rust
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# TUI Todo App
## Introduction
The TUI Todo App is a terminal-based todo list application built in Rust using the `tui` crate. It offers a rich, interactive experience for managing your tasks directly from the terminal.
__🤖 This project is created by ChatGPT 🤖__
## Usage
- Start the application by running `todo_app` from the terminal.
- Navigate through tasks with `jk`.
- Toggle task status with `space`.
- Add new tasks with `o`.
- Filter tasks with `/`.
- Backup tasks with `b`.
- Reset tasks with `r`.
## Building and Installing
### Prerequisites
- __Rust__: Ensure you have Rust installed. You can get it from [https://www.rust-lang.org/tools/install](https://www.rust-lang.org/tools/install).
- __Cargo__: Comes with Rust, used for building the project.
### Build Manually
1. __Clone the Repository__:
```sh
git clone https://github.com/longnghia/todo-tui.git
cd todo-tui
```
2. __Build the Project__:
To build the debug version of the application, run:
```sh
cargo build
```
### Using `make` (Optional)
If you prefer, you can use the provided `Makefile` to build and install the binary:
1. __Run `make` to build and install__:
```sh
make
```
2. __Run `make uninstall` to remove the binary__:
```sh
make uninstall
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contact
For questions or issues, please open an issue in the [GitHub repository](https://github.com/longnghia/todo-tui) or contact me directly.