Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hlsxx/tukai
The app provides an interactive typing experience with switchable templates, designed to help users improve their typing speed and accuracy
https://github.com/hlsxx/tukai
ratatui ratatui-rs rust rust-lang terminal terminal-based terminal-gui touchtyping typing typing-practice typing-trainer typingspeedtest
Last synced: about 1 month ago
JSON representation
The app provides an interactive typing experience with switchable templates, designed to help users improve their typing speed and accuracy
- Host: GitHub
- URL: https://github.com/hlsxx/tukai
- Owner: hlsxx
- License: mit
- Created: 2024-10-23T18:28:18.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-07T12:43:08.000Z (about 2 months ago)
- Last Synced: 2024-11-07T12:52:40.169Z (about 2 months ago)
- Topics: ratatui, ratatui-rs, rust, rust-lang, terminal, terminal-based, terminal-gui, touchtyping, typing, typing-practice, typing-trainer, typingspeedtest
- Language: Rust
- Homepage:
- Size: 337 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Tukai
Touch typing terminal based application
## About The Tukai
A terminal-based touch typing application built in Rust using the [Ratatui](https://github.com/crossterm-rs/ratatui) library. The app provides an interactive typing experience with switchable templates, designed to help users improve their typing speed and accuracy.
### Features
- **Touch Typing Practice**: Practice typing skills with real-time feedback on accuracy and speed
- **Switchable Templates**: Choose between different templates to customize the typing practice experience
- **Terminal-Based**: Simple, lightweight, and runs in the terminal for easy accessibility on any platform
- **Rust-Based**: Built with Rust for performance and reliability
## Getting Started
To get a local copy up and running follow these simple example steps.
### Installation
#### Step 1. Install Rust
If you don't have Rust installed, follow the instructions on the official [Rust website](https://www.rust-lang.org/tools/install) to install Rust.
#### Step 2: Clone the repository
Clone this repository to your local machine:
```sh
git clone https://github.com/hlsxx/tukai.git
cd tukai
```
#### Step 3: Run or build the application
```sh
cargo run
cargo build --release
```
## Usage / Shortcuts
- **ESC**: Exit the application
- **CTRL + R**: Restart and generate a new text
- **CTRL + S**: Switch between the templates
## Roadmap
- [x] Highlighted typed text
- [x] Highlighted mistakes
- [x] Calculate WPM and accuracy after the run
- [x] Display remaining time
- [x] Template switch
- [ ] Custom time picker
- [ ] Stats overview
- [ ] Activity overview
- [ ] Custom texts
## License
Distributed under the MIT License. See `LICENSE` for more information.