https://github.com/orhun/rustforge2025-ratatui-workshop
A 3-hour workshop to build your own resource monitor with Rust & Ratatui 🦀🐁
https://github.com/orhun/rustforge2025-ratatui-workshop
ratatui rust rustforge terminal terminal-user-interface tui workshop workshop-materials
Last synced: 2 days ago
JSON representation
A 3-hour workshop to build your own resource monitor with Rust & Ratatui 🦀🐁
- Host: GitHub
- URL: https://github.com/orhun/rustforge2025-ratatui-workshop
- Owner: orhun
- License: mit
- Created: 2025-08-19T16:43:08.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-08-27T17:41:17.000Z (about 1 month ago)
- Last Synced: 2025-09-26T22:35:58.068Z (12 days ago)
- Topics: ratatui, rust, rustforge, terminal, terminal-user-interface, tui, workshop, workshop-materials
- Language: Rust
- Homepage: https://rustforgeconf.com/
- Size: 7.96 MB
- Stars: 7
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Becoming a Terminal Chef with Ratatui 👨🍳🐀
> Your terminal can do more than you think and this workshop shows you how. [Ratatui](https://ratatui.rs) is the leading framework for building terminal user interfaces (TUIs) in Rust. This workshop by [Orhun Parmaksız](https://github.com/orhun), the framework's maintainer, will get you cooking up some tasty terminal UIs in no time.
### What will you build?
"**Ratatop**", a terminal resource monitor application that displays system information in real-time.
### Who is this workshop for?
The workshop is intended for Rust beginners who want to learn how to build TUIs with Ratatui.
Previous experience with Rust is not required, but it is recommended to have a basic understanding of the language.
- If you are already familiar with Rust, you can still follow along and learn about Ratatui.
- If you are already familiar with Ratatui, you can follow the _bonus tracks_ and learn something new!
#### Necessary Tools
- [git](https://git-scm.com/)
- [cargo](https://www.rust-lang.org/tools/install)
> [!TIP]
> It is recommended to disable AI completions in your code editor to get a better understanding of the code you write.
### Chapters
The workshop is split up into 5 chapters and aims to be completed **in 3 hours.**
| Duration | Chapter | Topic |
| ---------- | ------------- | ---------------------------------------------------------- |
| **10 min** | **Chapter 1** | **Setup** - Install Rust, cargo-generate, create project |
| **15 min** | **Chapter 2** | **Manage State** - Use `sysinfo`, refresh data |
| **30 min** | **Chapter 3** | **Layout & Styling** - Define UI structure, apply styles |
| **45 min** | **Chapter 4** | **Widgets** - Render charts, bar charts, sparklines, table |
| **20 min** | **Chapter 5** | **Interactivity** - Handle inputs, scroll table, search |
| **60 min** | 🧀 | **Q&A** / **Debugging** / **Extras** |
### Walkthrough
Use the [slides](presentation.md) to follow along with the workshop.
> [!TIP]
> You can use [`presenterm`](https://github.com/mfontanini/presenterm) to present the slides in your terminal.
>
> ```sh
> presenterm -c assets/presenterm.yml presentation.md
> ```
Start with installing [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) and creating a new Ratatui project via [`templates`](https://github.com/ratatui/templates):
```sh
cargo install cargo-generate
```
```sh
# select the "simple" template
cargo generate ratatui/templates
```
Then follow the chapters to build the **Ratatop** application. If you get stuck, check out the [examples](./examples) folder which contains the completed code for each chapter. We recommend to try it yourself first and only refer to the example code in case you run into issues.
The final code can be found in the [src/main.rs](./src/main.rs) file.
## Show and tell! 🧀
Join the [Ratatui Discord](https://discord.gg/pMCEU9hNEj) and share your creations with the other terminal chefs!
If you have any questions or need help, feel free to ask in the chat.
## License
Copyright © 2025, [Orhun Parmaksız](https://github.com/orhun)
Licensed under [The MIT License](./LICENSE)
🦀 ノ( º \_ º ノ) - respect crables!