appelgriebsch / rust-tui-template

A template for bootstrapping a Rust TUI application with ratatui & crossterm

ratatui-template 🧀

A template for bootstrapping a Rust TUI application with Ratatui & crossterm.

Project structure

src/
├── app.rs     -> holds the state and application logic
├── event.rs   -> handles the terminal events (key press, mouse click, resize, etc.)
├── handler.rs -> handles the key press events and updates the application
├── lib.rs     -> module definitions
├── main.rs    -> entry-point
├── tui.rs     -> initializes/exits the terminal interface
└── ui.rs      -> renders the widgets / UI

Creating a project

1. Install cargo-generate

cargo install cargo-generate

2. Clone this repository via cargo-generate:

cargo generate --git https://github.com/ratatui-org/ratatui-template --name <project-name>

See also

• Rust Munich Meetup #8 - Designing TUI Applications in Rust (2021/outdated)